skills.rest
huichen
huichenCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update project documentation files after code ships.

Updated Mar 31, 2026
Search Tags:#documentation#diff#docs#CHANGELOG#polish#CLAUDE#post-ship
One-click install
npx skills add https://github.com/huichen/gstack --skill document-release-huichen
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/huichen/gstack/tree/main/document-release
Command: npx skills add https://github.com/huichen/gstack --skill document-release-huichen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common. This Skill automates updates to core docs to reflect shipped changes, reducing manual toil and risk.

Core Features & Use Cases

  • Auto-sync: updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.
  • CHANGELOG polish: harmonizes voice and entries after a PR is merged.
  • TODOS cleanup and optional version bump to keep docs aligned.

Quick Start

Run the document-release skill after a PR is merged to automatically update the project's documentation.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate post-ship documentation updates after a PR is merged?▼

Automate post-ship documentation updates by running the document-release skill after a PR merges. It cross-references diffs to align README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with shipped changes.

What is the best way to keep project docs in sync with code changes?▼

Keeping project docs in sync with code changes requires automating updates to core files like README.md and CLAUDE.md. This skill cross-references diffs to reflect shipped changes and reduces manual toil.

How do I polish a CHANGELOG and harmonize entries after shipping?▼

Polish a CHANGELOG by harmonizing entry voices after a PR is merged. The skill automatically cleans up TODOS and aligns changelog entries to reflect the shipped code diffs.

Do I need a CLAUDE.md file to automate documentation updates?▼

Yes, you need a CLAUDE.md file to automate documentation updates. The skill requires access to repository docs and specifically modifies CLAUDE.md to align project context with shipped changes.

Can I automatically bump the VERSION and update CONTRIBUTING.md after a release?▼

Yes, you can automatically bump the VERSION and update CONTRIBUTING.md. The skill performs TODOS cleanup and optionally bumps versions to keep docs aligned after code ships.

Related Skills

Explore More Content & Communication Skills→
ligianehualigianehua

document-release

Update project documentation files based on the repository diff.

Community
Advanced
agatxagatx
5

document-release

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after releases.

Community
Advanced
ajsai47ajsai47
11

document-release

Update project markdown documentation by cross-referencing git diffs after code commits.

Community
Advanced
shin0720shin0720

auto-sync

Automate synchronization of SPEC files, CHANGELOG entries, and project documentation.

Community
Basic