Docs authoring
Docs surfacesโ
- End-user rule docs:
docs/rules/ - Docusaurus site docs:
docs/docusaurus/site-docs/ - TypeDoc API output:
docs/docusaurus/site-docs/developer/api/
Common tasksโ
Update README rules matrixโ
npm run sync:readme-rules-table
node scripts/sync-readme-rules-table.mjs --check
Regenerate TypeDoc docsโ
npm run docs:api
Build docs siteโ
npm run --workspace docs/docusaurus build:fast
Style guidanceโ
- Prefer short paragraphs and descriptive headings.
- Use consistent terminology across rules, presets, and developer docs.
- Keep links stable and avoid duplicated sources of truth.