document-release

Automating documentation updates after shipping involves cross-referencing code diffs to synchronize project files like README, ARCHITECTURE, and CONTRIBUTING with the latest changes. This process reads repo state and diff data to apply synchronized text edits automatically.

Post-ship documentation synchronization aligns project docs with shipped code changes by cross-referencing diffs. It is needed because manual updates are tedious and error-prone, often leaving README and ARCHITECTURE files out of sync with the actual codebase state.

Keeping CHANGELOG and TODOS current after a PR merge requires analyzing the merged diff to polish changelog language and tidy todo lists. Automated tooling can read these diffs and apply text edits to clean up outstanding tasks and version notes.

Automated documentation versioning can work without external dependencies by leveraging standard repo state, diff data, and built-in doc tooling. It uses commands like grep and diff to process text edits directly within the repository environment.

Automatically bumping the VERSION file during documentation updates is supported as an optional step. While polishing the CHANGELOG and synchronizing README files, the process can simultaneously apply a version bump to reflect the newly shipped changes.

The best way to update CLAUDE.md and ARCHITECTURE docs after a release is cross-referencing the shipped diff data against existing project documentation. This ensures all architectural decisions and agent instructions accurately reflect the current codebase state.