docs-audit

A documentation audit checks markdown files against the codebase to validate accuracy, code examples, and API signatures. This process identifies outdated information and ensures technical docs match the current implementation.

A documentation audit evaluates markdown files for link validity, code example correctness, CLI command accuracy, and docstring coverage. It ensures all documented configurations and signatures match the current codebase state.

You validate links by running a documentation audit that checks internal and external link validity across markdown files. This discovers broken references and ensures documentation links remain active and correctly targeted.

You verify code examples by auditing documentation against the current codebase state. This validates function signatures, configuration examples, and CLI command syntax to ensure documented code matches the actual implementation.

Yes, documentation audits can prioritize recently changed or stale files. This efficient discovery strategy focuses analysis on critical areas first, ensuring the most updated features receive priority review before release.

Yes, documentation auditing checks docstring coverage alongside markdown validation. It verifies functions have adequate docstrings and ensures API descriptions match actual implementation signatures in the codebase.