skills.rest
agatx
agatxCOMMUNITY
Explore all skills by this author →
GitHub

document-release

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

5|2|Updated Dec 27, 2025
Search Tags:#automation#workflow#documentation#release#diff#docs#CHANGELOG
One-click install
npx skills add https://github.com/agatx/serenada --skill document-release-agatx
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/agatx/serenada/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/agatx/serenada --skill document-release-agatx

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps project documentation aligned with shipped changes by automatically updating core guides (README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md), polishing changelog notes, and tidying TODOS after a release.

Core Features & Use Cases

  • Updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to reflect what shipped.
  • Polishes the CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION.
  • Proactively suggests documentation updates after PRs are merged or code is shipped.

Quick Start

Run document-release after a PR ships to update docs and changelog to match 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 automate documentation updates after a release or PR merge?▼

Automating documentation updates after a release involves aligning core files like README, ARCHITECTURE, and CONTRIBUTING with shipped changes. This Skill runs in PR contexts to automatically polish changelog notes, tidy TODOS, and optionally bump the VERSION file.

What is the best way to keep a CHANGELOG and README in sync with shipped code?▼

Keeping a CHANGELOG and README in sync requires automatically reflecting the latest shipped state across core guides. This tool polishes changelog voice, cleans up TODOS, and updates CLAUDE.md to match the merged code.

Can I automatically update CLAUDE.md and ARCHITECTURE docs when shipping changes?▼

Yes, you can update CLAUDE.md and ARCHITECTURE docs automatically by running documentation automation after a PR ships. The process respects proactive documentation-automation settings to align core files with the latest code state.

Does documentation automation work in PR contexts to reflect shipped changes?▼

Documentation automation works in PR contexts by proactively suggesting updates after PRs are merged or code is shipped. It aligns README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to accurately reflect the newly shipped changes.

When should I not use automated documentation syncing for project guides?▼

You should avoid automated documentation syncing when proactive documentation-automation settings are disabled. This ensures the automatic updating of core guides, changelog polishing, and TODO tidying only runs in intended PR contexts.

Do I need to manually bump the VERSION file when updating docs after a release?▼

You do not need to manually bump the VERSION file when updating docs after a release. The documentation automation optionally bumps VERSION automatically while polishing the CHANGELOG and aligning core project guides with the shipped state.

Related Skills

Explore More Content & Communication Skills→
shekerkammashekerkamma

document-release

Update project documentation to match shipped code changes.

Community
Advanced
marcel-heinzmarcel-heinz
4

release

Coordinate ClawCity release workflows with version bumps, changelog updates, git tagging, and GitHub releases.

Community
Advanced
leanEthereumleanEthereum
143

checks

Run linting, formatting, type, spell, and Markdown checks with ruff, ty, codespell, and mdformat.

Official
Intermediate
rahmanayonrahmanayon

document-release

Update project documentation to reflect shipped changes and polish changelog voice.

Community
Advanced