document-release

Automating documentation updates after a release cross-references project docs against commit diffs to apply factual changes, polish changelog voice, and update PR bodies. This ensures all files remain consistent and current post-ship.

Keeping CHANGELOG entries and docs consistent with commit history requires cross-referencing documentation against the diff to identify needed updates. The process refines changelog voice for clarity and updates or removes TODO items based on applied changes.

You can automatically update PR bodies with documentation changes for gstack projects by running a post-ship automation script. It commits the applied documentation updates and directly updates the PR body to reflect the new changes.

The documentation update process does not require manual confirmation for all changes. It automatically applies factual corrections directly, while specifically asking for user confirmation only when narrative changes are needed.

Cleaning up TODO items and bumping project versions after shipping is handled by auditing documentation against recent commits. It updates or removes TODO items based on project changes and optionally bumps the version.