document-release

Updates project documentation files to match shipped code changes after a release.

Updated Apr 5, 2026
One-click install
npx skills add https://github.com/VertaKhan/cs_gstack --skill document-release-vertakhan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/VertaKhan/cs_gstack/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/VertaKhan/cs_gstack --skill document-release-vertakhan

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 git 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 instructions. - Auto-Updates with Guardrails: Applies clear factual corrections directly while asking the user about risky narrative changes, VERSION bumps, and new TODOS items. - CHANGELOG Voice Polish: Rewrites entry wording to be user-forward without ever deleting or regenerating existing entries. - Use Case: After merging a feature branch that added a new CLI command, run this Skill to update the README feature table, fix the CONTRIBUTING setup steps, polish the CHANGELOG entry, and mark completed TODOS items. ## Quick Start Ask the AI 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 the git diff against the base branch, auto-applies factual corrections, and asks before risky narrative changes.

What documentation files does a post-ship docs update cover?▼

It audits README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, CHANGELOG.md, TODOS.md, and any other Markdown files found within two directory levels. Each file is checked against the branch diff for stale content.

Does document-release work with GitLab merge requests?▼

Yes, it detects the hosting platform from the git remote URL and supports both GitHub via gh and GitLab via glab. If neither CLI is available, it falls back to git-native commands to determine the base branch.

Can it rewrite or regenerate CHANGELOG entries?▼

No, it never deletes, reorders, or regenerates CHANGELOG entries. It only polishes wording within existing entries using exact-match edits, and asks the user if an entry looks wrong or incomplete.

When does document-release ask before making changes?▼

It asks for narrative rewrites, section removals, security model changes, VERSION bumps, and new TODOS items. Factual corrections like updated paths, counts, and version numbers are applied automatically.