Docs and Release Workflow
Docs authoring workflowโ
- Update source docs under
docs/rules/**ordocs/docusaurus/site-docs/** - Run relevant sync scripts for generated markdown tables
- Build docs (
npm run docs:build) - Verify no broken links and correct sidebar behavior
Release safety checklistโ
Before tagging/releasing:
- lint/typecheck/tests pass
- production build passes
- docs build passes
- generated docs and sidebar updates are committed
Common pitfallsโ
- Editing generated output instead of source
- Leaving stale links after route/sidebar changes
- Updating presets docs without re-running matrix/table sync