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

  1. Read docs/docs.json first to understand IA, tabs, and existing groups.
  2. Research source-of-truth implementation details before writing:
    • scan relevant files under src/
    • read /src/types.ts for public types/options/contracts
    • read /schema/isol8.config.schema.json for config keys/defaults/enums
  3. Read the target page(s) and at least 2 neighboring pages to match tone and structure.
  4. Load the mintlify skill and check whether a better component exists to represent the current content (instead of defaulting to plain Markdown).
  5. Choose the page archetype (overview, how-to, reference, guide, faq, troubleshooting, api).
  6. Apply the standards in references/docs-quality-manual.md.
  7. If adding pages, update navigation in docs/docs.json.
  8. Add cross-links to adjacent conceptual and reference pages.
  9. Run checks from references/review-checklist.md.
  10. Optionally run scripts/docs_qc.sh for quick structural linting.
Related skills

More from illusion47586/isol8

Installs
12
GitHub Stars
4
First Seen
Feb 28, 2026