document-release

Automate documentation updates by scanning shipped diffs to refresh README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files. The workflow audits consistency, proposes updates, and polishes the CHANGELOG and TODOS to reflect deployed changes accurately.

Keeping README and CHANGELOG aligned with post-ship diffs involves automatically scanning release changes and refreshing core documentation. It polishes CHANGELOG language, tidies TODOS, and optionally bumps VERSION to prevent documentation drift.

You can automatically bump VERSION and tidy TODOS by triggering the documentation workflow after shipping. It reads release diffs, proposes updates to core docs, and defers risky edits to user review for safe version management.

Automated change-log polishing handles risky edits by deferring them to user review. It proactively suggests documentation updates after a PR is merged or code is shipped, enforcing a workflow that audits consistency before applying changes.

You need to manually review only risky edits proposed for CONTRIBUTING and ARCHITECTURE docs. The workflow automatically syncs safe changes from shipped diffs but defers potentially risky updates to ensure documentation consistency and accuracy.

Trigger post-ship documentation workflows immediately after a PR is merged or code is shipped. This proactive approach reads current release diffs, prevents documentation drift, and keeps core docs synchronized with deployed changes.