document-release

Name: document-release
Availability: InStock
Author: singhianand23045

Sync project docs with shipped changes after releases and PR merges.

Updated Apr 12, 2026

Search Tags:#changelog #versioning #documentation #readme #diff #post-ship

Ready to run

npx skills add https://github.com/singhianand23045/GarryTan --skill document-release-singhianand23045

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/singhianand23045/GarryTan/tree/main/document-release
Command: npx skills add https://github.com/singhianand23045/GarryTan --skill document-release-singhianand23045

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are tedious and error-prone. This skill reads all project docs, cross-references the shipped changes, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what was released. It polishes the CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION to keep the project documentation in sync with code.

Core Features & Use Cases

Syncs documentation across key project files after merges or releases to prevent drift.
Polishes changelog language, cleans up pending TODOS, and optionally bumps the version.
Supports running proactively after merges or shipping events to keep docs current.

Quick Start

After a PR is merged or code is shipped, run document-release to refresh and align project docs.

Frequently Asked Questions about document-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automate documentation updates after a release?▼

To automate post-ship documentation updates, sync shipped code changes across project files like README and ARCHITECTURE. This ensures your docs reflect the latest release by deriving updates directly from shipped diffs.

What is the best way to keep a changelog and README in sync with merged code?▼

Keeping a changelog and README in sync with merged code requires cross-referencing shipped changes against existing docs. You can polish changelog language, clean up pending TODOS, and update project files to prevent documentation drift after merges.

How do I prevent documentation drift after merging PRs?▼

Preventing documentation drift after merging PRs requires reading project docs and cross-referencing them with shipped changes. This process updates files like CONTRIBUTING and CLAUDE.md based on the actual code diff.

Can I automatically bump the version and polish the changelog after shipping?▼

You can automatically bump the version and polish the changelog after shipping by applying post-ship documentation updates. This process cleans up pending TODOS and refines changelog voice while syncing project files with the released code.

Does post-ship documentation sync work for CLAUDE.md and ARCHITECTURE files?▼

Post-ship documentation sync works for CLAUDE.md and ARCHITECTURE files by reading these project docs and updating them to reflect shipped changes. This ensures all key project documentation stays aligned with the released codebase.