document-release

Scan diffs and sync README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after code shipping.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/mmunro3318/3d-render-pipeline --skill document-release-mmunro3318
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/mmunro3318/3d-render-pipeline/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/mmunro3318/3d-render-pipeline --skill document-release-mmunro3318

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation can drift from the deployed state; this skill updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes, polishes CHANGELOG, tidies TODOS, and optionally bumps VERSION.

Core Features & Use Cases

  • Automatic alignment of docs after PRs to match shipped changes.
  • Polishes CHANGELOG voice and tidies TODOS to reflect reality.
  • Optional version bump decisions and safe, auditable updates.
  • Supports workflows invoked via Bash, Read, Write, Edit, Grep, Glob, and AskUserQuestion.

Quick Start

Run the document-release skill after merging a PR to sync docs with shipped changes.

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 merging a pull request?

Automating documentation updates after a PR involves scanning code diffs to sync README, ARCHITECTURE, and CLAUDE.md files with shipped changes, while polishing the CHANGELOG and tidying TODOS.

What is the best way to sync core docs with shipped code changes?

Syncing core docs with shipped code changes requires orchestrating a Bash-based workflow that validates frontmatter, reads file diffs, and edits documentation to match the newly deployed state.

How does diff scanning work for post-ship documentation versioning?

Diff scanning for documentation versioning works by reviewing code changes and automatically applying those updates to core docs, optionally bumping the VERSION file and enforcing safety through allowed-tools validation.

Can I use Bash commands to update README and CHANGELOG files automatically?

Yes, you can use Bash commands to orchestrate automatic updates to README and CHANGELOG files by invoking workflow tools like Read, Write, Edit, Grep, and Glob to align documentation with shipped changes.

Do I need specific allowed-tools to run automated documentation workflows?

Yes, automated documentation workflows enforce safety by requiring specific allowed-tools to execute, validating frontmatter and ensuring auditable updates when syncing docs after a PR.

Why does post-ship documentation drift from the deployed state?

Post-ship documentation drifts from the deployed state because manual updates are often skipped after merging code, making automated diff scanning and doc synchronization necessary to reflect reality.