skills.rest
tropeks
tropeksCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Read release diffs and update documentation files to match shipped code.

Updated Mar 26, 2026
Search Tags:#versioning#documentation#diff#polish#docs-update#post-ship
One-click install
npx skills add https://github.com/tropeks/Vitali --skill document-release-tropeks
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/tropeks/Vitali/tree/main/.claude/skills/gstack-document-release
Command: npx skills add https://github.com/tropeks/Vitali --skill document-release-tropeks

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts between shipped code and documentation. This Skill automates keeping docs in sync by cross-referencing diffs and applying updates across multiple files.

Core Features & Use Cases

  • Reads diffs from the latest merge and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect the shipped changes.
  • Polishes CHANGELOG language and tidies TODOS; optionally bumps VERSION when appropriate.
  • Supports a pluggable, frontmatter-driven workflow to run checks and apply updates.

Quick Start

Run after a PR is merged to automatically align docs with current code and 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 release?▼

You can automate documentation updates by cross-referencing code diffs from a merged PR and applying those changes to README, ARCHITECTURE, and CLAUDE.md files to keep them in sync.

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

Keeping docs in sync involves reading the latest merge diff and automatically updating relevant documentation files to reflect the shipped changes, preventing drift between code and docs.

How do I polish CHANGELOG entries and tidy TODOS after a merge?▼

Polishing a CHANGELOG and tidying TODOS involves automatically refining the language and structure of these files based on the latest diff, and optionally bumping the VERSION file if appropriate.

Can I use YAML frontmatter to manage docs versioning workflows?▼

Yes, you can use YAML frontmatter for naming and versioning to drive a metadata-driven workflow, running checks and applying updates deterministically via a defined script set.

Does post-ship docs update support pluggable tooling for custom checks?▼

Yes, it supports pluggable tooling through a frontmatter-driven workflow, allowing you to run checks and apply updates deterministically across key documentation files.

When should I run an automated docs update for versioning?▼

You should run it immediately after a PR is merged to automatically align your README, CONTRIBUTING, and other key documentation with the current code changes.

Related Skills

Explore More Content & Communication Skills→
grafanagrafana
19

prevent-doc-drift

Patch AGENTS.md, CLAUDE.md, and .cursor/rules to reflect PR code changes.

Official
Advanced
t0labt0lab
2

release

Analyze Conventional Commits to draft changelogs and create release commits and tags.

Official
Advanced
faramirezsfaramirezs

design-md

Lint, diff, and export DESIGN.md token specification files.

Community
Advanced
ajsai47ajsai47
11

document-release

Update project markdown documentation by cross-referencing git diffs after code commits.

Community
Advanced