Documentation Maintenance Workflow
Product documentation should move with the codebase, not trail behind it, so docs updates belong in the normal definition of done for user-visible changes.
Update Docs When
- Public API shape changes
- Supported dialect behavior changes
- Diagnostics change
- Schema-loading behavior changes
- Migration guidance changes
Release And Migration Guidance
- Add release notes for new capabilities or behavior changes.
- Add migration notes when an existing usage pattern must change.
- Use the AI docs sync workflow when code and manual pages need to stay aligned across contributors.
Example
- Public API changed: update reference pages
- New diagnostic code: update error-code index and dedicated page
- New setup step: update Getting Started and troubleshooting