document-release

Automates updating project docs after inspecting committed code changes.

Updated Mar 23, 2026
One-click install
npx skills add https://github.com/fray-cloud/coin --skill document-release-fray-cloud
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/fray-cloud/coin/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/fray-cloud/coin --skill document-release-fray-cloud

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After shipping, project documentation often drifts out of date. This Skill automatically scans release diffs and applies updates across key docs to keep README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG in sync with what shipped.

Core Features & Use Cases

  • Auto-align documentation: read the diff from the latest ship and update README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG to reflect shipped changes.
  • Documentation polish: improve CHANGELOG tone, tidy TODOS, and optionally bump the VERSION.
  • One-click post-ship workflow: run the skill after PR merge to ensure docs match code and release notes.

Quick Start

Run the document-release skill after shipping to automatically align docs with the latest changes.

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 shipping a release?

Automate documentation updates by running a post-ship workflow that reads release diffs and updates README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG to reflect shipped changes. This ensures project docs automatically stay in sync with merged code without manual edits.

What is the best way to keep my CHANGELOG and README in sync with merged PRs?

Keeping CHANGELOG and README in sync with merged PRs is done by reading the diff from the latest ship and cross-referencing changes across key project docs. This automated diff-analysis approach applies updates to reflect the latest release consistently.

Can I automatically bump the version and update docs when code is shipped?

Yes, you can automatically bump the version when appropriate during the documentation update process. The workflow reads shipped diffs, aligns project docs, tidies TODOS, and optionally applies a version bump to keep all documentation consistent with the release.

Does this documentation automation work without external dependencies?

Yes, this documentation automation works without external dependencies. It operates independently after a PR is merged or code is shipped, reading diffs and updating project docs like README and CHANGELOG without requiring additional setup or installed packages.

When do I need to run post-ship documentation alignment?

Run post-ship documentation alignment immediately after a PR is merged or code is shipped. This prevents documentation drift by scanning the release diff and applying updates across README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG before the next development cycle begins.

What files does automated diff-analysis update when aligning project docs?

Automated diff-analysis updates README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG files. It reads the diff from the latest ship, cross-references the changes, and applies targeted updates to keep these key project docs consistent with the released code.