Documentation invariant (maintainer)¶
Documentation is checksum-tracked and test-enforced.
Invariant¶
- Every
docs/**/*.mdfile MUST appear indocs/doc_checksums.json. - Every tracked file MUST be listed in
docs/index.mdas a- docs/...bullet. - Each tracked file’s SHA-256 MUST match the value in
docs/doc_checksums.json.
Workflow when editing docs¶
- Edit docs.
- Regenerate
docs/doc_checksums.json(SHA-256 per file). - Ensure
docs/index.mdlists all tracked files.
The test enforcing this lives at tests/invariants/test_documentation_invariant.py.