code-review-docs

You can catch documentation drift by auditing your pages against the codebase to verify API accuracy, public surface coverage, and cross-reference integrity. This identifies outdated examples and missing coverage before users do.

A documentation coverage audit verifies that public exports, options, events, and edge cases are documented where readers expect to find them. It checks that all public surfaces in the codebase have corresponding reader-facing explanations.

To check API accuracy and cross-reference integrity, audit the documentation against the implementation to verify that examples, signatures, literal values, and internal links match the current source of truth without editing the files directly.

Yes, the documentation review checks structure and voice consistency. It confirms that pages follow project documentation patterns, including clear definitions, scannable headings, and a consistent tone throughout the content.

Yes, you can audit documentation without modifying source files. The review process verifies accuracy, coverage, structure, and cross-reference quality read-only, flagging issues for you to address without directly editing the files.

The best way to review stale examples and broken links is to run a doc-driven review loop that checks examples, literal values, behaviors, and cross-references against the current implementation to find outdated content before users do.