Skills

Docs Audit

Autonomous, report-only documentation review for Mastra docs.

Install

npx skills add mastra-ai/mastra --skill docs-audit -g -a claude-code -y
Repository
mastra-ai/mastra29.3k
Category
Writing
Updated
3d ago
License
See repository
Context cost
Mediumabout 2,948 tokens
Runs scripts
Yes, review before use

What it does

Autonomous, report-only documentation review for Mastra docs. Use when auditing changed docs against source, validating contextual code examples or API coverage, checking canonical mastra-docs guidance, or running narrow deterministic checks.

Documentation audit

Audit Mastra documentation autonomously against source, the canonical mastra-docs guidance, and narrow deterministic checks. This skill is for report-only reviews. Do not edit documentation, ask the user to select jobs, or submit a fix plan unless the user separately requests implementation after the audit.

Load first

  1. Activate the mastra-docs skill. Its references are the canonical authoring policy; do not restate their rules.
  2. Read:
    • references/RUBRIC.md
    • references/AUDIT-REPORT.md
    • .claude/skills/mastra-docs/references/STYLEGUIDE.md
    • .claude/skills/mastra-docs/references/INFORMATION_ARCHITECTURE.md
    • .claude/skills/mastra-docs/references/AUTHORING_WORKFLOW.md
  3. Add the applicable canonical references:
    • /docs pages: DOC.md
    • /integrations pages: GUIDE_INTEGRATION.md
    • /reference pages: REFERENCE.md
    • pages using shared MDX or llms-txt-aware components: COMPONENTS.md
    • pages containing Mermaid or diagram assets: DIAGRAM.md

Apply the verification rules in AUTHORING_WORKFLOW.md to every audit. Apply its move, delete, and redirect sections only when those operations are part of the reviewed diff.

Autonomous workflow

1. Determine the complete audit scope

Use the explicit files, URL, topic, or PR named by the user. Otherwise inspect the current PR/diff and include every changed authored page under:

  • docs/src/content/en/docs
  • docs/src/content/en/integrations
  • docs/src/content/en/reference

Do not ask the user to choose pages or jobs. Do not silently sample or cap a large changed-page set. Exclude generated pages unless the diff changes their generator or generated contract. Record any unavailable or ambiguous scope as a report limitation instead of starting a question loop.

2. Classify every page and map canonical guidance

Use these classifications:

Read the whole SKILL.md on GitHub

More in Writing