doc-validator

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.

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.

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.

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.

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.