document-release

Align post-ship documentation by scanning diffs and updating core docs.

Updated Mar 11, 2026
One-click install
npx skills add https://github.com/Liambiswell20-tech/Bolus-Brain --skill document-release-liambiswell20-tech
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Liambiswell20-tech/Bolus-Brain/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/Liambiswell20-tech/Bolus-Brain --skill document-release-liambiswell20-tech

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".

Core Features & Use Cases

  • Auto-sync and polish docs to reflect shipped changes across the primary docs.
  • Cross-reference diffs to update README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md.
  • Polish CHANGELOG voice, clean up TODOS, and optionally bump VERSION for a release.
  • Supported via a scripting workflow using Bash, Read, Write, Edit, Grep, Glob, AskUserQuestion.

Quick Start

Run the document-release workflow after ship to automatically align docs with shipped changes and optionally bump the VERSION.

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

Automating post-ship documentation updates involves scanning code diffs to sync project docs. This Skill aligns README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes while polishing the CHANGELOG and cleaning up TODOS.

How does diff analysis work for syncing project documentation?

Diff analysis for syncing documentation works by cross-referencing shipped code changes against existing files. It reads project docs, identifies mismatches with the diff, and updates content to accurately reflect the new release state.

What is the best way to keep a changelog and README updated after shipping?

Keeping a changelog and README updated after shipping is best handled by an automated workflow. This Skill cross-references diffs to update docs and polishes the CHANGELOG voice to ensure consistency across all core files.

Can I automatically bump the version number when updating documentation?

Yes, you can automatically bump the version number when updating documentation. This Skill optionally bumps the VERSION file as part of the post-ship sync workflow, alongside updating README, ARCHITECTURE, and CONTRIBUTING files.

Does this documentation workflow require external dependencies or tools?

This documentation workflow does not require external dependencies. It operates independently using built-in scripting capabilities like Bash, Read, Write, Edit, Grep, Glob, and AskUserQuestion to orchestrate the syncing process.

When should I run a post-ship documentation sync?

You should run a post-ship documentation sync immediately after shipping new changes. Use it when asked to update the docs or sync documentation, ensuring README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md reflect the latest code state.