gstack-document-release

Post-release documentation updates work by auditing project docs against the real git diff. This process updates coverage maps and architecture notes to reflect shipped changes, ensuring documentation matches reality rather than initial intentions.

A Diataxi coverage map categorizes docs into reference, how-to, tutorial, and explanation formats. You need it after a ship to selectively generate coverage artifacts and ensure all shipped changes are documented across the correct documentation types.

Detect architecture drift by comparing shipped code diffs against existing architecture diagrams and documentation. This mismatch check ensures your architecture notes stay consistent with the actual codebase structure after a release.

Changelog voice cleanup polishes release notes using a sell-test rubric and removes stale TODOs. You can surface this documentation debt directly in the PR body, alongside an optional VERSION bump, to maintain clear post-release communication.

Yes, this workflow applies to both post-merge and post-release scenarios. It performs repository-wide reading and writing to update contributing guidance and reference docs whenever documentation must reflect what changed in a merged PR.

The best way to keep READMEs aligned is diff-aware cross-referencing against the shipped code. By automatically auditing project docs against the real git diff, you ensure contributing guidance reflects actual code modifications.