doc-validator

Validate markdown documentation for completeness, accuracy, and consistency with the codebase.

7|Updated Nov 23, 2025

Search Tags:#documentation #markdown #readme #quality #docs #validate #api-docs

Ready to run

npx skills add https://github.com/poindexter12/waypoint --skill doc-validator-poindexter12

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-validator
Source: https://github.com/poindexter12/waypoint/tree/main/claire/skills/doc-validator
Command: npx skills add https://github.com/poindexter12/waypoint --skill doc-validator-poindexter12

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Automates documentation quality checks to ensure README files, API references, CHANGELOGs, and other markdown documentation stay accurate, complete, and consistent with the codebase.

Core Features & Use Cases

Completeness: installation instructions, usage guidance, API reference, troubleshooting, and contributing guidelines.
Accuracy: runnable code examples, commands match the CLI, correct file paths, version alignment, and non-broken links.
Consistency: uniform terminology, formatting, and unique headings across docs.
Quality: clear language, proper markdown, and well-formed code blocks.
Use Case: When reviewing a project’s docs, run doc-validator to surface missing sections and broken links.

Quick Start

Run the doc-validator to audit your repository’s documentation and generate a validation report.

Frequently Asked Questions about doc-validator

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

FAQPage Schema

How do I check my markdown documentation for missing sections and broken links?▼

To check markdown documentation for missing sections and broken links, you can validate docs to ensure completeness and accuracy. This process audits README files and API docs to surface installation steps, usage guidance, and non-broken links.

What is the best way to validate that my API docs match my codebase?▼

The best way to validate API docs match your codebase is running an automated documentation check. This enforces accuracy by verifying runnable code examples, CLI commands, correct file paths, and version alignment against the actual codebase.

How do I enforce consistent formatting and terminology across project README files?▼

To enforce consistent formatting and terminology across project README files, apply a documentation validation process. It checks for uniform terminology, proper markdown formatting, well-formed code blocks, and unique headings across all docs.

Can I check a CHANGELOG for version alignment and proper markdown automatically?▼

Yes, you can check a CHANGELOG for version alignment and proper markdown automatically. A documentation validator audits CHANGELOGs to ensure version alignment with the codebase and verifies that markdown formatting and code blocks are well-formed.

Does documentation validation work for catching outdated instructions in API references?▼

Documentation validation works for catching outdated instructions in API references by checking accuracy. It verifies that file paths, CLI commands, and version numbers within the API references are current and consistent with the codebase.