Developer overview
This section is the maintainer-facing companion to the public docs site.
Use it when you are changing the Docusaurus app, rule-reference navigation, generated README/preset surfaces, or published API documentation.
Start hereâ
- Architecture explains how the public rule docs, project pages, and developer routes fit together.
- Workflow charts maps the docs and generation flow that keeps the site aligned.
- ADRs captures the architectural decisions behind the current information architecture.
- API reference is generated from the public
src/plugin.tssurface.
Related routesâ
- Rule overview
- Preset matrix
- Public project page:
/project - Public resources page:
/resources
What belongs hereâ
This developer section is the right place for:
- docs architecture notes
- generation and sync workflows
- ADRs
- charts and process maps
- published API reference material
It is not the place to duplicate end-user rule explanations. Keep those in
docs/rules/**.