document-release

Automating documentation updates after shipping requires scanning released diffs to synchronize README, ARCHITECTURE, CONTRIBUTING, and AGENTS.md files. This process cross-references code changes and automatically updates project documentation to reflect exactly what was released.

Keeping README and CHANGELOG files in sync with merged pull requests involves reading PR-driven diffs and polishing CHANGELOG language. This approach automatically adjusts core documentation and cleans up TODOS to maintain consistency across the repository.

You can automatically bump the VERSION file when documentation changes warrant a new release. This process performs optional version bumps during doc synchronization, or defers them to a later release if appropriate.

This documentation synchronization approach preserves existing content and file structure. It enforces end-to-end doc hygiene by reading diffs and updating key files while ensuring the original repository structure remains intact.

You should run a post-ship documentation synchronization workflow immediately after a ship. It scans the shipped changes, cross-references diffs, and updates key docs to reflect what shipped, ensuring your repository documentation stays aligned with the latest code.

Diff cross-referencing for project documentation works by scanning shipped code changes and comparing them against existing docs. It automatically updates README, ARCHITECTURE, CONTRIBUTING, and AGENTS.md files to accurately reflect the released modifications.