document-release

Updates README, ARCHITECTURE, CONTRIBUTING, AGENTS docs based on scanned diffs after shipping.

1|Updated Mar 15, 2026
One-click install
npx skills add https://github.com/westn/gstack-pi-port --skill document-release-westn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/westn/gstack-pi-port/tree/main/port/gstack/document-release
Command: npx skills add https://github.com/westn/gstack-pi-port --skill document-release-westn

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common. This Skill reads all project docs, cross-references the diff, updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and AGENTS.md to match what shipped, polishes CHANGELOG language, cleans up TODOS, and optionally bumps VERSION. Proactively suggests improvements after PRs or code ships.

Core Features & Use Cases

  • Updates documentation to reflect ship state across README.md, ARCHITECTURE.md, CONTRIBUTING.md, and AGENTS.md
  • Polishes CHANGELOG language and cleans up TODOS
  • Optionally bumps VERSION after a release
  • Performs doc reviews to maintain consistency across the project
  • Supports on-demand doc drift fixes during post-ship checks

Quick Start

Run the document-release skill after shipping to align and polish all 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 update project documentation after shipping a new release?

To update project documentation after shipping, you can scan code diffs and apply matching changes to README.md, ARCHITECTURE.md, CONTRIBUTING.md, and AGENTS.md. This process syncs docs with the shipped state and polishes the CHANGELOG voice.

What is post-ship documentation drift and how do I fix it?

Post-ship documentation drift happens when shipped code changes are not reflected in project docs. You fix it by cross-referencing the code diff to update README.md and ARCHITECTURE.md, cleaning up TODOS, and polishing CHANGELOG language to maintain consistency.

How do I sync my README and ARCHITECTURE files with recent code changes?

You sync README and ARCHITECTURE files by parsing the recent diff and modifying the Markdown files to match what shipped. This minimizes churn by guiding updates strictly through the detected code changes.

Can I automatically bump my project VERSION and polish the CHANGELOG at the same time?

Yes, you can automatically bump your project VERSION and polish the CHANGELOG at the same time. The process updates documentation across the project and optionally bumps the VERSION after a release alongside CHANGELOG language improvements.

Do I need write access to the repository to sync docs after a code ship?

Yes, you need read and write access to the repository to sync docs after a code ship. The process requires parsing and modifying Markdown files directly within the repository to apply the diff-guided updates.