document-release

Automates post-ship documentation updates by reading project diffs and aligning docs.

Updated Mar 29, 2026

Search Tags:#automation #documentation #CHANGELOG #diff-analysis #docs-sync #post-ship

Ready to run

npx skills add https://github.com/ibalasite/gstack --skill document-release-ibalasite

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/ibalasite/gstack/tree/main/document-release
Command: npx skills add https://github.com/ibalasite/gstack --skill document-release-ibalasite

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation frequently drifts after code changes. This skill automates the process to read diffs and align multiple docs with what shipped, reducing manual toil and drift.

Core Features & Use Cases

Reads the project diff and cross-references relevant docs to reflect shipped changes.
Updates core docs like README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md; polishes CHANGELOG language; cleans up TODOS.
Optionally bumps VERSION when appropriate and can run post-ship documentation workflows after PR merges or code ships.

Quick Start

Run document-release after shipping to automatically refresh and align documentation across the project.

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 a code ship?▼

Automating post-ship documentation updates involves reading project diffs, cross-referencing affected files, and aligning docs with what shipped. This process automatically refreshes README, ARCHITECTURE, CONTRIBUTING, and CHANGELOG files to reflect merged changes.

What is the best way to sync CHANGELOG entries with merged PRs?▼

Syncing CHANGELOG entries with merged PRs is done by analyzing project diffs and polishing the language to match the shipped code. The process cleans up TODOS and aligns the documentation with the actual modifications introduced in the merge.

How do I keep README and ARCHITECTURE docs aligned with code changes?▼

Keeping README and ARCHITECTURE docs aligned with code changes requires cross-referencing project diffs against these files. This ensures the documentation accurately reflects the shipped features and structural updates without manual toil.

Can I automatically bump the version when updating post-ship documentation?▼

Automatically bumping the version during post-ship documentation updates is supported. When requested, the workflow reads the project diff, aligns the core documentation, and optionally increments the project VERSION file to match the new release state.

Does post-ship docs sync work without external dependencies?▼

Post-ship docs sync operates without external dependencies, relying on the gstack environment configuration. It supports optional proactive suggestions and contributor mode to tailor the documentation updates directly within the project workflow.