document-release

Update project documentation from git diffs across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

Updated Mar 31, 2026
One-click install
npx skills add https://github.com/hetsheth-droid/toolbox-template --skill document-release-hetsheth-droid
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/hetsheth-droid/toolbox-template/tree/main/incubating/gstack/document-release
Command: npx skills add https://github.com/hetsheth-droid/toolbox-template --skill document-release-hetsheth-droid

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation update. Reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION. Use when asked to "update the docs", "sync documentation", or "post-ship docs". Proactively suggest after a PR is merged or code is shipped. (gstack)

Core Features & Use Cases

  • Cross-document diff-aware updates: read changes, apply consistent updates across README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md.
  • Changelog voice polish: adjust wording to improve readability without altering history.
  • TODOS cleanup and optional version bump: tidy TODOS and bump VERSION when appropriate.
  • Proactive documentation syncing: suggest docs updates after PR merges or code ships.

Quick Start

Run the document-release skill after a ship to sync and polish 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 automatically update project documentation after a ship?▼

Automatically update project documentation after a ship by reading code diffs to cross-reference changes and apply consistent updates across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files.

What is the best way to sync README and ARCHITECTURE docs with merged code changes?▼

The best way to sync README and ARCHITECTURE docs is to cross-reference the code diff against existing documentation and apply consistent updates to ensure all project files match what shipped.

How do I polish changelog wording to improve release note readability?▼

Polish changelog wording by adjusting the text voice to improve readability without altering the historical record, ensuring release notes remain accurate and clear.

Does updating post-ship documentation require read and write access to the repository?▼

Yes, updating post-ship documentation requires read and write access to the repository because the workflow uses shell utilities to directly modify files like README and CLAUDE.md.

Can I automatically bump the VERSION file when syncing documentation?▼

Yes, you can automatically bump the VERSION file when syncing documentation, as the workflow tidies TODOS and optionally increments the version when appropriate to reflect the shipped changes.