document-release

Automate post-ship documentation updates by scanning repository diffs and aligning shipped changes across core project docs like README.md, ARCHITECTURE.md, and CONTRIBUTING.md. This workflow cross-references diffs to ensure your documentation reflects what was actually shipped, reducing manual polish time and preventing documentation drift.

Keeping README and CONTRIBUTING files in sync with shipped code changes requires cross-referencing repository diffs against existing documentation. This Skill reads all project docs, aligns them with the shipped diff, polishes CHANGELOG language, cleans up TODOS, and optionally bumps the VERSION number to reflect the new release.

Automatically bumping the VERSION in repository docs after a release is supported as an optional feature. When running the post-ship documentation update workflow, it reads the current docs, aligns them with shipped changes, and can optionally bump the VERSION to accurately reflect the newly shipped release.

This documentation sync workflow updates CLAUDE.md and ARCHITECTURE.md files alongside README.md and CONTRIBUTING.md. It reads all project docs and cross-references the shipped diff to ensure consistency across these core files, guaranteeing that architectural guidelines and agent instructions reflect the latest code changes.

Polishing CHANGELOG language and cleaning up TODOS after shipping code is handled by the post-ship documentation update workflow. It reads your repository diffs, aligns the core project docs with the shipped changes, refines the CHANGELOG text for clarity, and removes completed TODOS to maintain a clean project state.

Run a post-ship docs update workflow after merges or code ships when you need to update core project documentation. It is specifically designed for syncing documentation after a PR merge, generating post-release notes, or executing requested updates like "update the docs" or "post-ship docs" to prevent drift.