document-release

Updates project documentation files to match shipped code changes.

2|Updated Mar 26, 2026
One-click install
npx skills add https://github.com/westkite1201/garden-engine --skill document-release-westkite1201
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/westkite1201/garden-engine/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/westkite1201/garden-engine --skill document-release-westkite1201

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After shipping code, project documentation like README, ARCHITECTURE, CONTRIBUTING, and CHANGELOG often drifts out of sync with what actually shipped. This Skill audits every documentation file against the branch diff and brings them back into alignment before a PR merges. ## Core Features & Use Cases - Diff-driven doc audit: Reads all Markdown docs and cross-references them against the branch diff to find stale features, paths, counts, and commands. - Safe auto-updates with guardrails: Applies factual corrections directly while asking the user about narrative, security, or large rewrite decisions. - CHANGELOG voice polish and VERSION check: Polishes changelog wording without clobbering entries, cleans up TODOS, and confirms version bump decisions via prompts. - Use Case: After merging a feature branch that adds a new CLI command, run this Skill to update the README feature table, fix the project structure section in CLAUDE.md, polish the CHANGELOG entry, and commit the doc updates to the PR. ## Quick Start Ask the assistant to run the document-release workflow to sync all project documentation with the changes on the current feature branch.

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

Run the document-release workflow from a feature branch after code is committed. It reads all Markdown docs, cross-references them against the branch diff, applies factual fixes automatically, and asks before making narrative or risky changes.

How to keep README and CHANGELOG in sync with a release?

Use a diff-driven documentation audit that compares doc content against git changes on the branch. This Skill updates README feature lists, polishes CHANGELOG voice without rewriting entries, and verifies the VERSION file matches the changelog.

Does this workflow modify CHANGELOG entries automatically?

It never rewrites, deletes, or regenerates CHANGELOG entries. It only polishes wording within existing entries using exact-match edits, and asks the user before any change that would alter meaning.

Can it bump the VERSION file without asking?

No. Version bumps always require explicit user confirmation through a prompt. If VERSION was already bumped, it checks whether the bump covers the full scope of branch changes before deciding to skip.

What happens if no documentation needs updating?

The workflow runs a git status check first. If no documentation files were modified, it outputs that all documentation is up to date and exits without creating a commit.