document-release

Update project documentation files based on the repository diff.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts after releases. This skill automatically aligns project docs with shipped changes to keep teammates on the same page.

Core Features & Use Cases

  • Reads the diff to identify what changed and what documentation needs updating.
  • Updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.
  • Polishes the CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION after a release.
  • Proactively suggests documentation improvements after a PR is merged or code is shipped.

Quick Start

Run the document-release skill to scan the latest commit and update the docs accordingly.

Frequently Asked Questions about 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 prevent post-ship documentation drift, this skill reads the repo diff and updates documentation files like README.md, ARCHITECTURE.md, and CLAUDE.md. It keeps teammates aligned by ensuring project docs accurately reflect the latest shipped changes.

How do I sync my README and CLAUDE.md with my latest commit diff?

You can sync your README and CLAUDE.md by running this skill to scan the latest commit diff. It performs read/write edits across Markdown files to ensure documentation accurately reflects the codebase changes that were just shipped.

What is the best way to polish a CHANGELOG and clean up TODOS after shipping?

The best way to polish a CHANGELOG and clean TODOS is to use an automated post-ship workflow that reads the diff and refines the text. This skill polishes the CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION file.

Can I update ARCHITECTURE.md and CONTRIBUTING.md based on a git diff?

Yes, you can update ARCHITECTURE.md and CONTRIBUTING.md based on a git diff. The skill relies on reading the diff and using shell utilities for parsing and editing to apply the necessary updates across these documentation files.

Does post-ship documentation update work without external dependencies?

Yes, post-ship documentation update works without external dependencies. The skill uses shell utilities for parsing and editing Markdown files directly, requiring no additional components or packages to align docs with shipped changes.