document-release

You can automate post-ship documentation updates by comparing project code changes with existing Markdown files, updating relevant docs, and optionally bumping the version number. This streamlines the process of keeping documentation accurate after merging a feature branch.

Preparing a CHANGELOG after a merge involves refining the changelog voice and removing any leftover TODO items. This process cross-references code changes to ensure the changelog accurately reflects the post-ship updates.

Yes, automated documentation update works directly with Git version control. It requires Git to compare project documentation with code changes and read project files to update Markdown documentation post-ship.

Yes, you can automatically update project files like README, ARCHITECTURE, CONTRIBUTING, and AGENTS.md. The process reads existing Markdown documentation, cross-references it with code changes, and updates the relevant files.

The best way to keep Markdown documentation accurate is to run an automated post-ship update process. This cross-references code changes with existing Markdown documentation, updates relevant files, and optionally bumps the project version number.