skills.rest
tan-yong-sheng
tan-yong-shengCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

gstack-document-release

Update project Markdown docs to match shipped code changes.

1|1|Updated Mar 5, 2026
Search Tags:#versioning#documentation#README#CLAUDE.md#CHANGELOG#post-ship
One-click install
npx skills add https://github.com/tan-yong-sheng/GrowChat --skill gstack-document-release
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: gstack-document-release
Source: https://github.com/tan-yong-sheng/GrowChat/tree/main/.claude/skills/gstack-document-release
Command: npx skills add https://github.com/tan-yong-sheng/GrowChat --skill gstack-document-release

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship projects often drift as docs lag behind shipped changes. gstack-document-release reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION.

Core Features & Use Cases

  • Reads diffs, updates key docs to reflect shipped state.
  • Polishes CHANGELOG wording and tidies TODOS to reflect the current release.
  • Optionally bumps the project's VERSION to align with the new release.

Quick Start

Ask gstack to run the document-release workflow after shipping to refresh README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to the latest shipped state.

Frequently Asked Questions about gstack-document-release

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

FAQPage Schema
How do I automatically update documentation after a release?▼

To automatically update documentation after a release, use a post-ship workflow that reads project diffs and updates README, ARCHITECTURE, and CONTRIBUTING files to match the latest shipped changes.

What is post-ship documentation synchronization?▼

Post-ship documentation synchronization is the process of aligning project docs with what shipped by cross-referencing diffs, updating Markdown files, polishing CHANGELOG wording, and cleaning up TODOS.

How do I keep my CHANGELOG and CLAUDE.md aligned with shipped changes?▼

You keep your CHANGELOG and CLAUDE.md aligned with shipped changes by running a document-release workflow that cross-references project diffs, polishes CHANGELOG voice, and updates Markdown files to reflect the current release.

Does the document release workflow bump the project version automatically?▼

Yes, the document release workflow can optionally bump the project's VERSION to align with the new release, alongside refreshing README and ARCHITECTURE docs.

When should I run a post-ship documentation sync?▼

You should run a post-ship documentation sync after merges or releases to prevent project docs from lagging behind shipped changes and ensuring all Markdown files reflect the latest state.

Can I tidy up TODOS when updating post-ship docs?▼

Yes, you can tidy up TODOS when updating post-ship docs, as the document-release process cleans up TODOS and polishes CHANGELOG wording to accurately reflect the current release.

Related Skills

Explore More Content & Communication Skills→
armanzeroeightarmanzeroeight
29

commit-message-generator

Generates commit messages from git diff output with customizable Type and Scope options.

Community
Basic
dhntdhnt

tag-release

Create and push annotated Git tags for version-bump commits.

Official
Intermediate
mgher668mgher668

document-release

Synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped diffs.

Community
Advanced
wheels-devwheels-dev
203

Wheels Documentation Generator

Generate CFML documentation, READMEs, and API docs for CFWheels applications.

Official
Basic