document-release

Update project documentation after code shipping events.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship projects often fall out of sync as changes land in code but documentation lags. This skill reads all project docs, compares changes to what shipped, and updates the key docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md) to reflect the latest state.

Core Features & Use Cases

  • Cross-reference and update documentation to reflect shipped changes across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.
  • Polish changelog language, tidy TODOS, and optionally bump the VERSION when it’s warranted after a ship.
  • Proactively suggest and apply documentation updates after a PR merge or code shipping events to keep a project in sync.

Quick Start

Run the document-release skill after a ship or PR merge to auto-sync and polish your project docs.

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 code changes?

Automate post-ship documentation updates by parsing project diffs and applying changes to README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md. The skill reads shipped changes and syncs your project docs to reflect the latest state.

What is the best way to keep README and ARCHITECTURE docs in sync with merged PRs?

Keep README and ARCHITECTURE docs in sync by running an automated docs-sync process after a PR merge. It compares code diffs against existing documentation and applies necessary updates to keep everything aligned.

Can I automatically polish changelog language and clean up TODOS after a release?

Yes, you can polish changelog language and clean up TODOS as part of an automated post-ship documentation update. The process refines change-log entries and tidies leftover TODOS to maintain clear project documentation.

Does this docs-sync process require any specific dependencies or components?

No specific dependencies or components are required. The docs-sync process relies on standard file operations like Bash, Read, Write, Edit, Grep, and Glob to parse diffs, modify files, and interact with you for decisions.

How do I bump the VERSION file when shipping new changes?

Bump the VERSION file during post-ship documentation updates by optionally applying a version increment when warranted. The skill evaluates shipped changes and interacts with you to decide if a version bump is needed.

When should I not use automated post-ship documentation updates?

Avoid automated post-ship documentation updates when your project lacks established docs like README or ARCHITECTURE files to compare against, or when you need manual control over changelog wording rather than automated language polishing.