Skip to main content

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.ts surface.

What belongs here​

This developer section is the right place for:

  1. docs architecture notes
  2. generation and sync workflows
  3. ADRs
  4. charts and process maps
  5. published API reference material

It is not the place to duplicate end-user rule explanations. Keep those in docs/rules/**.