document-release

Reconcile post-release documentation by aligning README, ARCHITECTURE, CONTRIBUTING, CLAUDE, and CHANGELOG with shipped changes.

Updated Apr 5, 2026
One-click install
npx skills add https://github.com/VertaKhan/cs_gstack --skill document-release-vertakhan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/VertaKhan/cs_gstack/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/VertaKhan/cs_gstack --skill document-release-vertakhan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation updates often lag after ship. This Skill automatically updates READMEs, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect the shipped state, polishes the changelog, cleans up TODOS, and can bump VERSION when appropriate.

Core Features & Use Cases

  • Update README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.
  • Polish CHANGELOG language and tidy TODOS to match the released state.
  • Optionally bump VERSION to reflect the release.

Quick Start

Run the document-release skill on the repository after shipping to synchronize all 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 automatically sync README and CHANGELOG after a release?

To sync README and CHANGELOG after a release, you can run the document-release workflow to automatically reconcile post-ship docs. It applies a read-diff then rewrite workflow to align README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with shipped changes.

What is the best way to update project documentation to reflect shipped changes?

The best way to update project documentation to reflect shipped changes is using an automated documentation sync tool. This skill polishes the CHANGELOG language, tidies TODOS, and aligns core docs with the released state through a traceable read-diff and rewrite process.

How do I polish CHANGELOG language and clean up TODOs after shipping?

To polish CHANGELOG language and clean up TODOs after shipping, you can run an automated docs-sync workflow. It rewrites the changelog to match the released state and cleans up outdated TODOs while generating traceable logs of all modifications.

Can I automatically bump the VERSION file when updating post-release documentation?

Yes, you can automatically bump the VERSION file when updating post-release documentation. The skill optionally applies a version bump to reflect the release alongside reconciling README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md.

How does post-ship documentation reconciliation handle missing sections or manual edits?

Post-ship documentation reconciliation handles missing sections or manual edits by applying an automated read-diff and rewrite workflow. It specifically manages these common edge cases to ensure README.md, ARCHITECTURE.md, and CONTRIBUTING.md align accurately with shipped changes.

When should I use an automated docs-sync workflow for post-release documentation?

You should use an automated docs-sync workflow for post-release documentation when applying PR merges or running release workflows. It effectively aligns README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with shipped changes, preventing documentation from lagging after ship.