document-release

Automate post-ship documentation updates by scanning project docs, cross-referencing code diffs, and modifying Markdown files to reflect shipped changes. This keeps your repository aligned with the latest release without manual edits.

Keeping README and CHANGELOG files synchronized involves cross-referencing shipped diffs against existing documentation and refining the wording to match release notes. This ensures your project docs accurately reflect the current state of the codebase.

Updating CONTRIBUTING and ARCHITECTURE docs to match a version bump requires reading the repository state and editing the Markdown files. The process optionally bumps version metadata and reports the outcome of the documentation update.

Yes, you can clean up outstanding TODOS when refreshing project documentation. The workflow reads repo state and refines documentation files, ensuring that completed items are addressed while polishing the CHANGELOG and aligning it with release notes.

Run an automated documentation synchronization workflow immediately after a PR is merged. This timing ensures that README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files consistently reflect the newly shipped release without manual intervention.