verifying-layer-documentation

To identify documentation gaps, traverse layer documentation and actual source code from architecture entry points to produce a gaps.md listing missing items and inaccuracies. This verification process compares documented items against the codebase to output a structured report.

Layer documentation gap analysis detects drift between documentation and source code. You need it when documentation often drifts from code, requiring automated identification of missing items and inaccuracies across architectural layers to maintain accuracy.

Generate a gaps report by running verification after layer analysis. The process traverses layer documentation and source code, enforcing tagging and formatting rules to write results to docs/unwind/layers/{layer}/gaps.md without applying any fixes.

Documentation verification requires a specific codebase structure with layer documentation stored in docs/unwind/layers/{layer} and source entry points defined in an architecture.md file to function properly.

No, the gap analysis does not automatically fix documentation inaccuracies. It produces a focused work list by writing missing items and inaccuracies to gaps.md, allowing you to address the documentation gaps manually.

The best way to maintain accurate documentation is to run automated verification that cross-references layer documentation against actual source code entry points, generating a structured gaps report to highlight drift and missing items.