Workflow charts
This page turns the docs maintenance process into explicit flows instead of tribal knowledge.
Docs publication flowâ
rule docs + source metadata
â
preset / README sync scripts
â
developer docs + API generation
â
Docusaurus build
â
published site
Surface ownership mapâ
| Surface | Source of truth | Published route |
|---|---|---|
| Rule overview and rule pages | docs/rules/** | /docs/rules/** |
| Project / resources landing pages | src/pages/** | /project, /resources |
| Developer docs and ADRs | site-docs/developer/** | /developer/** |
| API reference | TypeDoc output from src/plugin.ts | /developer/api/** |
| README rule matrix | sync scripts | repository root README |
Validation flowâ
- generate API docs
- build docs site
- validate typecheck
- validate tests for synced surfaces
- review browser output
Why charts matter hereâ
The docs app now has enough moving pieces that maintainers should not have to reverse-engineer the flow from scripts every time they touch it.