document-release

Automate documentation updates by cross-referencing the shipped code diff to align README and architecture files with new features or command behavior. This ensures post-ship docs accurately reflect project changes without manual edits.

Keeping a CHANGELOG and VERSION synced involves deterministic doc audits that polish changelog voice, clean up TODOs, and optionally bump the VERSION. This requires cross-referencing the git diff to constrain edits around factual release modifications.

Cross-doc diff syncing works by reading all project docs and updating contributor guides based on evidence from the code diff. It modifies only paths, capabilities, and commands warranted by the shipped changes to maintain accurate onboarding instructions.

You can generate a PR body documentation diff preview as a final step after committing synchronized docs. This provides a visible summary of how README and related documentation were updated to match the shipped code changes.

Use automated release management for repository documentation when shipped changes include new features, command behavior updates, removed functionality, or infrastructure adjustments. It ensures deterministic doc audits and constrained edits for accurate post-ship synchronization.

Document-release requires optional user confirmation to bump the project VERSION when docs warrant a release. This ensures deterministic versioning control while automating the rest of the documentation synchronization workflow.