skills.rest
shhubbh
shhubbhCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Apply shipped code diffs to synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

1|Updated Mar 28, 2026
Search Tags:#automation#documentation#diff#docs#CHANGELOG#polish#post-ship
One-click install
npx skills add https://github.com/shhubbh/flowstate --skill document-release-shhubbh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/shhubbh/flowstate/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/shhubbh/flowstate --skill document-release-shhubbh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates across the repository by reading shipped changes and applying them to core docs.

Core Features & Use Cases

  • Automatically sync README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.
  • Polishes CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION.
  • Provides a repeatable workflow after PR merges to keep docs current.

Quick Start

Run the document-release skill after a PR merge to refresh shipped documentation.

Frequently Asked Questions about document-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate post-merge documentation updates for README and ARCHITECTURE files?▼

Automating post-merge documentation updates involves scanning project docs and applying shipped diffs to synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files automatically after a PR merge.

What is the best way to polish CHANGELOG voice and clean up TODOS after shipping?▼

Polishing CHANGELOG voice and cleaning up TODOS requires reading shipped changes and applying structured updates to refine release notes and remove completed task items during post-ship synchronization.

Can I automatically bump VERSION files when synchronizing docs after a PR merge?▼

You can optionally bump VERSION files when running post-ship documentation synchronization, which scans diffs and applies updates alongside CHANGELOG polishing and TODO cleanup.

Do I need repository access with Bash and Grep to apply diffs to project docs?▼

Repository access with the allowed-toolset including Bash, Read, Write, Edit, Grep, Glob, and AskUserQuestion is required to perform diff analysis and apply document updates.

How does diff analysis work for syncing CLAUDE.md and CONTRIBUTING.md with shipped changes?▼

Diff analysis for syncing CLAUDE.md and CONTRIBUTING.md works by scanning shipped code changes, identifying relevant documentation impacts, and applying structured updates to keep core docs current.

Related Skills

Explore More Content & Communication Skills→
LukasStricklerLukasStrickler
4

docs-check

Analyze git diffs to identify required documentation updates after code changes.

Community
Basic
jayzalowitzjayzalowitz
2

document-release

Update core docs and CHANGELOG after shipping code changes.

Community
Advanced
TheTesseractAITheTesseractAI

post_merge_setup

Automate dependency installation and workflow synchronization after code merges.

Community
Intermediate
zaeem-rafiqzaeem-rafiq

document-release

Automate post-ship documentation updates across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE files.

Community
Advanced