Docs Operations¶
Documentation operations keep handbook structure, navigation, and publishing integrity aligned with repository standards.
Visual Summary¶
flowchart LR
author[author or update docs] --> validate[run docs-check]
validate --> review[review links and structure]
review --> publish[publish docs artifacts]
Operational Rules¶
- handbook structures must match documented section contracts
- MkDocs navigation must include all canonical pages
- docs changes must ship with behavior changes in the same pull request
Documentation Preflight¶
Before merging docs-heavy changes:
- run
make docs-check - confirm nav entries match filesystem paths
- confirm no page links reference retired documents
- confirm style and tone follow handbook standards
Standard Commands¶
Code Anchors¶
mkdocs.ymlmkdocs.shared.ymlmakes/docs.mkdocs/automation/publish_contract_assets.py