document-release

Automate documentation updates by analyzing release diffs, applying factual auto-updates to docs, flagging risky changes, and polishing the CHANGELOG voice for consistency. This ensures project documentation accurately reflects the latest shipped changes.

Auditing documentation against a release diff involves parsing the changes, checking cross-document consistency, and cleaning up outdated TODOs. This process identifies factual updates needed in READMEs, architecture docs, and contributing guidelines.

Ensure cross-document consistency by applying auto-updates based on the release diff, polishing voice across files, and verifying discoverability. This flags questionable changes and aligns all project documentation with the new release.

Yes, you can optionally bump the version number, commit the updated documentation, and modify the PR body. This integrates the documentation audit and cleanup directly into your existing release workflow.

Yes, automating post-ship documentation cleanup requires git, bash, grep, sed, python, and gstack. These dependencies are used to parse release diffs, apply factual updates, and remove outdated TODO items across the project.

A documentation audit flags risky changes to prompt manual review of questionable modifications found in the release diff. This precaution prevents incorrect auto-updates from propagating inconsistencies across project documentation.