skills.rest
jkhowland
jkhowlandCOMMUNITY
Explore all skills by this author →
Website𝕏@jkhowlandGitHub

document-release

Sync core docs with repository changes after a PR merge.

Updated Mar 11, 2026
Search Tags:#automation#documentation#diff#docs#update#version
One-click install
npx skills add https://github.com/jkhowland/jkhowland --skill document-release-jkhowland
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/jkhowland/jkhowland/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/jkhowland/jkhowland --skill document-release-jkhowland

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is resolved by automatically syncing core docs with the latest shipped changes, ensuring consistency across README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md.

Core Features & Use Cases

  • Update core docs (README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md) to reflect what shipped.
  • Polish CHANGELOG language, clean up TODOS, and optionally bump VERSION after a PR is merged.
  • Proactively suggest documentation updates after code is shipped to keep docs aligned with reality.

Quick Start

Run the document-release skill after a PR merge to align all docs with the shipped state.

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 documentation after a PR is merged?▼

To update documentation after a PR merge, this skill syncs shipped code changes with core docs like README.md, ARCHITECTURE.md, and CONTRIBUTING.md. It reads repository diffs and writes updates to ensure your docs reflect the latest shipped state.

What is the best way to keep README and CHANGELOG aligned with shipped code changes?▼

Keeping README and CHANGELOG aligned with shipped code is done by reading repository diffs and polishing changelog language. This skill deterministically updates core docs and cleans up TODOS to prevent post-ship documentation drift.

How does documentation syncing handle VERSION bumps and risky updates?▼

Documentation syncing handles VERSION bumps and risky updates by prompting the user via AskUserQuestion. The Bash-based workflow deterministically reads diffs, writes updates, and pauses for user input when a version bump is requested after a merge.

Can I update ARCHITECTURE.md and CLAUDE.md automatically based on repository diffs?▼

Yes, you can automatically update ARCHITECTURE.md and CLAUDE.md based on repository diffs. The skill runs through a Bash-based workflow to sync these core docs with the latest shipped changes without requiring extra components.

When should I run post-ship documentation updates for my repository?▼

You should run post-ship documentation updates immediately after a PR is merged. Running the skill at this point aligns all core documentation, polishes the CHANGELOG, and cleans up TODOS to match the new repository state.

Related Skills

Explore More Content & Communication Skills→
scanbottscanbott

document-release

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after shipping code releases.

Community
Advanced
CaltexBevoCaltexBevo

document-release

Update core documentation files to reflect shipped code changes.

Community
Advanced
onelee85onelee85

gsd-ship

Push verified feature branches, create PRs, trigger reviews, and track merge status.

Community
Advanced
ChegginCheggin
1

documentation-generator

Generate API references, user guides, and changelogs from code and git history.

Community
Advanced