Skip to main content
Kodelyth ECC
Command

/update-docs

Update README and documentation to match the current code

Run:/update-docs

Update Documentation

Sync documentation with the codebase, generating from source-of-truth files.

Step 1: Identify Sources of Truth

| Source | Generates | |--------|-----------| | package.json scripts | Available commands reference | | .env.example | Environment variable documentation | | openapi.yaml / route files | API endpoint reference | | Source code exports | Public API documentation | | Dockerfile / docker-compose.yml | Infrastructure setup docs |

Step 2: Generate Script Reference

  • Read package.json (or Makefile, Cargo.toml, pyproject.toml)
  • Extract all scripts/commands with their descriptions
  • Generate a reference table:
| Command | Description |
|---------|-------------|
| npm run dev | Start development server with hot reload |
| npm run build | Production build with type checking |
| npm test | Run test suite with coverage |

Step 3: Generate Environment Documentation

  • Read .env.example (or .env.template, .env.sample)
  • Extract all variables with their purposes
  • Categorize as required vs optional
  • Document expected format and valid values
| Variable | Required | Description | Example |
|----------|----------|-------------|---------|
| DATABASE_URL | Yes | PostgreSQL connection string | postgres://user:pass@host:5432/db |
| LOG_LEVEL | No | Logging verbosity (default: info) | debug, info, warn, error |

Step 4: Update Contributing Guide

Generate or update docs/CONTRIBUTING.md with:

  • Development environment setup (prerequisites, install steps)
  • Available scripts and their purposes
  • Testing procedures (how to run, how to write new tests)
  • Code style enforcement (linter, formatter, pre-commit hooks)
  • PR submission checklist

Step 5: Update Runbook

Generate or update docs/RUNBOOK.md with:

  • Deployment procedures (step-by-step)
  • Health check endpoints and monitoring
  • Common issues and their fixes
  • Rollback procedures
  • Alerting and escalation paths

Step 6: Staleness Check

  • Find documentation files not modified in 90+ days
  • Cross-reference with recent source code changes
  • Flag potentially outdated docs for manual review

Step 7: Show Summary

Documentation Update
──────────────────────────────
Updated:  docs/CONTRIBUTING.md (scripts table)
Updated:  docs/ENV.md (3 new variables)
Flagged:  docs/DEPLOY.md (142 days stale)
Skipped:  docs/API.md (no changes detected)
──────────────────────────────

Rules

  • Single source of truth: Always generate from code, never manually edit generated sections
  • Preserve manual sections: Only update generated sections; leave hand-written prose intact
  • Mark generated content: Use markers around generated sections
  • Don't create docs unprompted: Only create new doc files if the command explicitly requests it

← All commands