Docs Quality Checklist
QA checklist for maintaining production-grade documentation quality.
Content quality gates
- Title and description frontmatter added
- Page has installation or entry point context
- Page has practical usage guidance (not only definitions)
- Code snippets compile and are copy-safe
- Internal links are valid
- API surface matches current package exports
- Dark and light mode readability verified
- Package names/versions are accurate
- Performance and accessibility notes included
Release quality gates
- New or changed exports are reflected in docs
- Migration notes added for breaking changes
- Search can find the new page/feature terms
- No placeholder rows remain in API tables