sync-docs

You can keep documentation in sync with code changes by parsing git diffs to identify modified files and updating README, CLAUDE docs, and API references to match the actual implementation. This avoids generating unnecessary files while updating only relevant docs.

Your README has stale or contradictory information because manual documentation updates often lag behind codebase changes. Scanning git diffs after code commits identifies outdated content and aligns developer guides with the latest implementation.

Yes, you can update API references and frontmatter content based on a git diff. The process parses the diff output, detects affected documentation sections, and modifies only the relevant frontmatter and content to reflect the new code state.

Yes, documentation synchronization works in both post-commit and pre-release workflows. Running during these stages ensures docs accuracy before deployment by validating that all developer guides and API references reflect the committed codebase changes.

The best way to avoid modifying unrelated files when updating docs is to scope updates strictly to the parsed git diff. By detecting only the documentation sections affected by the code changes, the process leaves unrelated files untouched.

You need to scan for missing or contradictory documentation when your codebase changes introduce new features or modify existing APIs. Running a diff-based check post-commit detects discrepancies and updates the docs to reflect the actual implementation.