Contracts
Reader-Facing Documentation Contract
docs/index.md is the landing page for the site
- reader-first content should stay ahead of implementation detail in navigation
Reference should remain the last top-level navigation section
- ADR and reference discovery should remain available from the docs surface
- the repo should build as a root-English MkDocs site
.docs-template-info.json records the current normalization marker
- editorial metadata should render through
overrides/partials/edition.html
- build metadata should come from
hooks/update_date.py, not page-local overrides
- semantic registry output should be generated during site builds
MCP Contract
docs/agent/manifest.yaml and docs/agent/start-here.md are the minimum MCP entrypoints
docs/context/*.md should describe the real repo rather than generic defaults
- repo-local docs remain the source of truth for this repo’s ownership and workflows