skills.rest
apeejay-education
apeejay-educationOFFICIAL
Explore all skills by this author →
GitHub

document-release

Align documentation files with shipped changes after merges.

1|Updated Mar 26, 2026
Search Tags:#documentation#pr-review#diff-analysis#version-bump#change-log#post-ship
One-click install
npx skills add https://github.com/apeejay-education/cadencesprout --skill document-release-apeejay-education
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/apeejay-education/cadencesprout/tree/main/.agents/skills/gstack-document-release
Command: npx skills add https://github.com/apeejay-education/cadencesprout --skill document-release-apeejay-education

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common across READMEs, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md. This skill automates cross-reference of shipped changes, updates docs to reflect what shipped, and helps maintain accurate project narratives.

Core Features & Use Cases

  • Reads the diff from merged changes and updates multiple docs to reflect the shipped state.
  • Polishes CHANGELOG language, cleans up TODOS, and can optionally bump VERSION to align with the release.
  • Proactively suggests documentation updates after PR merges, reducing manual drift and rework.

Quick Start

Run this skill after a PR is shipped to synchronize docs across the project and prepare a PR with the 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 a PR merge?▼

Automate documentation updates after a PR merge by analyzing the shipped diff and synchronizing multiple project files like README.md and ARCHITECTURE.md to reflect the new state.

What is the best way to prevent documentation drift across multiple markdown files?▼

Prevent documentation drift by enforcing cross-document alignment and frontmatter consistency across README, ARCHITECTURE, CONTRIBUTING, and CLAUE files after shipped changes are merged.

How do I polish a changelog and bump a version automatically after shipping?▼

Polish a changelog and bump a version automatically by running a post-ship process that cleans up TODOS, refines changelog language, and optionally aligns the VERSION file with the release.

Can I update CONTRIBUTING.md and CLAUDE.md based on the latest merged changes?▼

Update CONTRIBUTING.md and CLAUDE.md based on the latest merged changes by running a cross-referencing process that aligns project narratives with the actual shipped diff.

Does this post-ship documentation process prepare a PR with the updated changes?▼

Post-ship documentation synchronization prepares a PR with the updated changes by proactively suggesting documentation updates and aligning multiple files with the shipped state.

Related Skills

Explore More Content & Communication Skills→
ArroganceGArroganceG

document-release

Align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after a ship.

Community
Advanced
prata0xprata0x

release

Automate end-to-end software releases via PR-based version bumps and PyPI publishing.

Community
Advanced
yocxy2yocxy2

land-and-deploy

Merge pull requests and verify production deployment health with canary checks.

Community
Advanced
evanfang0054evanfang0054

documentation-sync

Automates project documentation updates from code changes.

Community
Advanced