Skip to content

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:

  1. run make docs-check
  2. confirm nav entries match filesystem paths
  3. confirm no page links reference retired documents
  4. confirm style and tone follow handbook standards

Standard Commands

make docs-check
make docs-serve
cargo run -q -p bijux-dev --bin bijux-dev-cli -- docs-audit

Code Anchors

  • mkdocs.yml
  • mkdocs.shared.yml
  • makes/docs.mk
  • docs/automation/publish_contract_assets.py

Next Reads