Keeping Rule Docs and Presets in Sync
ยท One min read
Rule docs and presets can drift if sync workflows are treated as optional.
Working modelโ
- Hand-author rule explanations and examples.
- Generate derived indexes/tables with repository scripts.
- Validate links and route stability in CI.
Why this mattersโ
A plugin can have technically correct rules and still be frustrating to adopt if documentation and preset behavior diverge. Sync automation reduces that risk, but maintainers still need to curate the narrative docs intentionally.