skills.rest
Andy-HNU
Andy-HNUCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Synchronize Markdown docs with shipped changes after PR merges.

Updated Mar 9, 2026
Search Tags:#automation#changelog#documentation#diff#docs#polish#version
One-click install
npx skills add https://github.com/Andy-HNU/AndyClaw --skill document-release-andy-hnu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Andy-HNU/AndyClaw/tree/main/skills/gstack-document-release
Command: npx skills add https://github.com/Andy-HNU/AndyClaw --skill document-release-andy-hnu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After shipping code, project documentation often drifts from what was actually released. This Skill automatically synchronizes core docs (README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md), polishes changelog prose, and tidies TODOS to reflect shipped changes.

Core Features & Use Cases

  • Synchronize README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with the latest shipped changes.
  • Polish CHANGELOG voice and clean up TODOS to improve readability and consistency.
  • Optionally bump VERSION after a release and surface proactive documentation hygiene prompts.

Quick Start

Run the document-release skill after shipping to synchronize docs, polish changelog prose, and optionally bump the VERSION.

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 shipping code?▼

Automate documentation updates by running a post-ship synchronization process that aligns README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with the latest shipped changes using lightweight diffing.

How do I keep my CHANGELOG and TODOS consistent with merged PRs?▼

Keep your CHANGELOG and TODOS consistent by polishing the changelog voice and tidying TODOs automatically after PR merges, ensuring project documentation reflects the actual release state.

Can I automatically bump the VERSION file after a release?▼

Yes, you can optionally bump the VERSION file after a release as part of the post-ship documentation synchronization process to maintain version control accuracy.

Does this documentation sync tool edit Markdown files in place?▼

Yes, this documentation sync tool edits Markdown files in place, relying on lightweight diffing to ensure only relevant sections are updated based on shipped changes.

What is the best way to prevent project docs from drifting after a release?▼

Prevent project docs from drifting by applying an automated post-ship alignment that refreshes core documentation, polishes changelog prose, and bumps the version to match the shipped code.

How does frontmatter metadata control documentation synchronization activation?▼

Frontmatter metadata controls documentation synchronization activation by signaling the process to read the metadata and determine when to refresh docs, polish changelogs, and tidy TODOS after shipping.

Related Skills

Explore More Content & Communication Skills→
jayzalowitzjayzalowitz
2

document-release

Update core docs and CHANGELOG after shipping code changes.

Community
Advanced
kreuzberg-devkreuzberg-dev
91

release-procedure

Guide alef maintainers through GitHub release cutting, tagging, and publishing.

Official
Advanced
TobiasPerryTobiasPerry

document-release

Read diffs and update core project documentation after shipping.

Community
Advanced
mikeacjonesmikeacjones

doc-sync

Synchronize CLAUDE.md navigation indexes and README architecture docs across a repository.

Community
Basic