docs-audit

Audit VitePress markdown docs against the Nimbus codebase for accuracy.

3|Updated Mar 27, 2026
One-click install
npx skills add https://github.com/NimbusPowered/Nimbus --skill docs-audit-nimbuspowered
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-audit
Source: https://github.com/NimbusPowered/Nimbus/tree/main/.claude/skills/docs-audit
Command: npx skills add https://github.com/NimbusPowered/Nimbus --skill docs-audit-nimbuspowered

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill prevents users from being misled by outdated or incorrect documentation by auditing every docs page against the current Nimbus codebase, so what’s published actually matches what’s real.

Core Features & Use Cases

  • Full docs inventory: Scans the docs/ tree for markdown pages, then reads docs/.vitepress/config.ts to understand navigation expectations.
  • Accuracy cross-references: Verifies configuration keys/defaults, API endpoints and models, command syntax and registries, and event names/payloads against source code.
  • Completeness detection: Identifies features present in code but missing documentation coverage across commands, API routes, config options, events, and major modules.
  • Organization and UX/DX checks: Detects dead sidebar links, orphaned pages, broken internal links, inconsistent terminology, and missing frontmatter.

Quick Start

Use the docs-audit skill to audit the docs/ folder against the current Nimbus codebase and generate a severity-based report with concrete fixes for critical inaccuracies first.

Frequently Asked Questions about docs-audit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit VitePress documentation against my source code?

To audit VitePress documentation, the skill recursively inventories markdown pages and sidebar configs, cross-references documented claims with source code, and generates a severity-prioritized accuracy report with a fix plan.

What does a documentation audit check for completeness in a codebase?

A documentation audit checks for completeness by identifying features present in source code but missing coverage across configuration keys, API endpoints, command registries, and event payloads.

How do I find broken links and orphaned pages in my VitePress docs folder?

Finding broken links and orphaned pages involves scanning the docs tree and checking VitePress sidebar configurations to detect dead links, missing frontmatter, and structurally broken documentation.

How do I verify API reference accuracy against my codebase?

Verifying API reference accuracy requires cross-referencing documented API endpoints and models with actual source code routes and models to identify misleading or outdated claims.

Does the documentation audit support config validation for default values?

Yes, config validation is supported by verifying documented configuration keys and defaults against actual configuration classes in the source code to ensure published values match reality.

What is the best way to prioritize fixes for outdated documentation?

Prioritizing fixes for outdated documentation is handled by generating a structured report that ranks identified inaccuracies by criticality, ensuring the most misleading issues are addressed first.