Skip to main content

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​

SurfaceSource of truthPublished route
Rule overview and rule pagesdocs/rules/**/docs/rules/**
Project / resources landing pagessrc/pages/**/project, /resources
Developer docs and ADRssite-docs/developer/**/developer/**
API referenceTypeDoc output from src/plugin.ts/developer/api/**
README rule matrixsync scriptsrepository root README

Validation flow​

  1. generate API docs
  2. build docs site
  3. validate typecheck
  4. validate tests for synced surfaces
  5. 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.