Skip to main content

Docs Governance

This page defines how we keep docs accurate and useful.

Source of truth

  • code and tests are the final truth
  • status snapshots live in:
    • api/docs/PROJECT_SUMMARY.md
    • api/docs/PROGRESS.md
    • api/docs/ENVIRONMENT_MATRIX.md

Docusaurus pages should explain these clearly, not compete with them.

Update rule

If behavior changes, docs change in the same PR.

Done means done

A feature is not done until docs include:

  • runtime behavior updates
  • env var changes
  • operational impact and runbook notes