skills.rest
ekrishgupta
ekrishguptaCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Detect codebase changes and update shipped documentation files after merges.

1|3|Updated Mar 19, 2026
Search Tags:#automation#changelog#documentation#diff#update#version-bump#gemstack
One-click install
npx skills add https://github.com/ekrishgupta/gemstack --skill document-release-ekrishgupta
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/ekrishgupta/gemstack/tree/main/document-release
Command: npx skills add https://github.com/ekrishgupta/gemstack --skill document-release-ekrishgupta

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation update automation that keeps project docs aligned with shipped changes across README, ARCHITECTURE, CONTRIBUTING, and GEMINI.md.

Core Features & Use Cases

  • Automatically reads diffs after a PR merge and updates the documentation surface to reflect the shipped state.
  • Polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION when appropriate.
  • Proactively suggests documentation improvements after code is shipped and can be invoked on demand.

Quick Start

Trigger this skill after a PR ships to refresh documentation across core project docs.

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 merge?▼

To automatically update documentation after a PR merge, trigger the skill to read post-ship diffs and refresh README, ARCHITECTURE, CONTRIBUTING, and GEMINI.md files to reflect the latest shipped code state.

What is post-ship documentation synchronization?▼

Post-ship documentation synchronization is the process of detecting codebase changes after merges or releases and proactively proposing updates to core project docs to keep them aligned with shipped code.

Can I automatically bump the VERSION file and clean up the CHANGELOG?▼

Yes, you can automatically bump the VERSION file and polish the CHANGELOG voice, as the skill includes optional version bump logic and cleans up TODOS with guardrails to prevent unsafe changes.

Does this documentation automation tool require external dependencies?▼

No, this documentation automation tool requires no external dependencies, using deterministic Bash scripting with read and edit access to docs to operate directly on your codebase.

When should I run documentation updates for shipped code?▼

You should run documentation updates for shipped code immediately after a PR ships or a release occurs, ensuring README, ARCHITECTURE, and CONTRIBUTING files accurately reflect the newly merged changes.

Related Skills

Explore More Content & Communication Skills→
mylukinmylukin
247

project-analyze

Generate ARCHITECTURE.md documentation from codebase analysis.

Community
Intermediate
TwoTonedTwoToned

document-release

Scan shipped changes and update project documentation files.

Official
Advanced
fghaffarfghaffar

document-release

Update project docs by cross-referencing diffs after PR merges.

Community
Advanced
zzxtbetazzxtbeta

document-release

Update project documentation from branch diffs after shipping.

Community
Advanced