skills.rest
mulyoved
mulyovedCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Scan repository diffs and update core documentation to reflect shipped changes.

Updated Mar 30, 2026
Search Tags:#automation#documentation#CLAUDE.md#CHANGELOG#docs-sync#post-ship
One-click install
npx skills add https://github.com/mulyoved/awesome-agent-ides --skill document-release-mulyoved
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/mulyoved/awesome-agent-ides/tree/main/.agents/skills/gstack/document-release
Command: npx skills add https://github.com/mulyoved/awesome-agent-ides --skill document-release-mulyoved

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from the actual codebase. This Skill reads the diff across the repository and updates critical docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md) to match what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION.

Core Features & Use Cases

  • Cross-checks project docs against shipped changes and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.
  • Polishes CHANGELOG prose, cleans up TODOS, and optionally bumps the VERSION to reflect new releases.
  • Automatically triggers after PR merges or code ships to keep documentation in sync.

Quick Start

Run the document-release skill after shipping to sync docs with the latest changes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update documentation after a release to match shipped code?▼

Keep docs up-to-date after shipping by scanning repository diffs and updating README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match shipped changes. This automated post-ship documentation alignment prevents docs from drifting from the actual codebase.

What is the best way to keep CLAUDE.md and CHANGELOG in sync after a PR merge?▼

The best way to keep CLAUDE.md and CHANGELOG in sync is automating post-ship documentation updates by scanning diffs. This updates core docs to reflect what shipped, polishes CHANGELOG prose, and cleans up TODOS automatically after PR merges.

Can I automatically bump the VERSION file when updating docs after shipping?▼

Yes, you can bump the VERSION file when syncing docs after shipping. The version bump is applied safely only when requested, alongside updating README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, polishing CHANGELOG prose, and cleaning up TODOS.

Do I need repo access and diffs to align documentation with shipped changes?▼

Yes, aligning documentation with shipped changes requires access to repo files and diffs. The Skill reads these diffs to safely edit core docs like CLAUDE.md and ARCHITECTURE, ensuring they accurately reflect what shipped.

When should I not use automated post-ship documentation updates?▼

You should not use automated post-ship documentation updates when you lack access to repo files and diffs, as the Skill requires them to scan changes and safely edit docs. It is designed specifically for post-ship alignment, not initial doc creation.

Related Skills

Explore More Content & Communication Skills→
I194I194
9

document-release

Scan project diffs and update core documentation to reflect shipped changes.

Community
Advanced
plurigridplurigrid
60

changelog-generator

Generate user-facing changelogs from git commit history.

Official
Advanced
jayzalowitzjayzalowitz
2

document-release

Update core docs and CHANGELOG after shipping code changes.

Community
Advanced
ligianehualigianehua

document-release

Update project documentation files based on the repository diff.

Community
Advanced