docs-quality
Installation
SKILL.md
Docs Quality
Use this skill to produce documentation that is accurate, scannable, and complete enough for first-time and advanced users.
Workflow
- Read
docs/docs.jsonfirst to understand IA, tabs, and existing groups. - Research source-of-truth implementation details before writing:
- scan relevant files under
src/ - read
/src/types.tsfor public types/options/contracts - read
/schema/isol8.config.schema.jsonfor config keys/defaults/enums
- scan relevant files under
- Read the target page(s) and at least 2 neighboring pages to match tone and structure.
- Load the
mintlifyskill and check whether a better component exists to represent the current content (instead of defaulting to plain Markdown). - Choose the page archetype (
overview,how-to,reference,guide,faq,troubleshooting,api). - Apply the standards in
references/docs-quality-manual.md. - If adding pages, update navigation in
docs/docs.json. - Add cross-links to adjacent conceptual and reference pages.
- Run checks from
references/review-checklist.md. - Optionally run
scripts/docs_qc.shfor quick structural linting.