Skip to content
Topogram

Documentation Maintenance

Documentation Maintenance

Section titled “Documentation Maintenance”

Current docs must describe current CLI and engine behavior. Historical context belongs in topogram-project.

Rules

Section titled “Rules”
  • Start from current code, CLI help, generated project output, and the dogfood topo/ model.
  • Keep first-use docs short and audience-oriented.
  • Separate user workflows from authoring and maintainer workflows.
  • Avoid redirect-only docs; keep old paths only when code/tests still require them.
  • Do not reintroduce stale command names or old DSL vocabulary.
  • Run docs checks after editing public docs.

Check

Section titled “Check”
Terminal window
npm run docs:check

The check validates local markdown links, verifies the greenfield first-run commands against a generated starter project, checks brownfield API/UI and CLI import walkthroughs against fixture imports, checks agent first-run guidance, checks template/catalog provenance wording against generated starter metadata, checks key command families against topogram --help, and rejects known stale command names.

GitHub · Apache 2.0 · llms.txt · npm install -D @topogram/cli