updating-documentation-for-changes

A documentation consistency sweep validates staged git diffs against core project docs like README.md and CHANGELOG.md before committing. It reads staged file changes and reports outdated or missing documentation references without modifying any files.

Auditing cross-references involves scanning existing docs for references to staged code changes. This process systematically validates consistency across README.md, CLAUDE.md, DESIGN_DOC.md, API docs, and project metadata to identify mismatches before a commit.

No, this documentation checklist does not modify any files during the audit. It reads staged file changes, scans existing docs for references, and outputs a report suggesting necessary updates for a clean commit without writing to the files.

A pre-commit documentation consistency check includes core project files such as README.md, CLAUDE.md, DESIGN_DOC.md or ARCHITECTURE.md, CONTRIBUTING.md, API docs, and CHANGELOG.md or HISTORY.md, plus project-specific metadata.

Validate CHANGELOG.md updates by running a systematic documentation sweep after staging your git changes. The sweep reads the staged diffs and checks the CHANGELOG.md or HISTORY.md file to report any missing or outdated references for a clean commit.

You need to run documentation consistency validation prior to committing staged changes. It ensures all related documentation across core project files and cross-referenced materials is current, avoiding missed references before finalizing the commit.