document-release

Automate post-ship documentation updates by scanning diffs and aligning project docs.

Updated May 11, 2026
One-click install
npx skills add https://github.com/wodeh/gstack-kimi --skill document-release-wodeh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/wodeh/gstack-kimi/tree/main/document-release
Command: npx skills add https://github.com/wodeh/gstack-kimi --skill document-release-wodeh

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are tedious and error-prone. This Skill reads project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to reflect what shipped, polishes the CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION. Use when you are asked to "update the docs", "sync documentation", or "post-ship docs".

Core Features & Use Cases

  • Automated post-ship documentation alignment: reads shipped changes and updates relevant docs to reflect the latest state.
  • CHANGELOG and TODO polish: harmonizes release notes and tasks with the shipped changes to maintain a clean project narrative.
  • Proactive documentation hygiene: suggests or applies minor doc tweaks after a PR merge or release.

Quick Start

Run document-release after a ship to automatically synchronize and polish the core docs across the project files.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate post-ship documentation updates after a release?

Automating post-ship documentation updates involves scanning project docs and cross-referencing diffs to align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files with shipped changes. This process also polishes the CHANGELOG and cleans up TODOS to maintain a clean project narrative.

What is the best way to sync documentation with merged PR changes across multiple repositories?

Syncing documentation across multi-repo projects requires reading shipped diffs and applying deterministic edits to core docs. This ensures README, ARCHITECTURE, and CONTRIBUTING files reflect the latest state across all integrated repositories without manual overhead.

Can I automatically update CLAUDE.md and bump VERSION files based on a code diff?

Yes, updating CLAUDE.md and bumping VERSION files based on code diffs is supported. The tool reads project docs, cross-references the shipped changes, and performs deterministic edits to align documentation and optionally bump the VERSION when requested.

How does post-ship documentation alignment handle CHANGELOG and TODO cleanup?

Post-ship documentation alignment handles CHANGELOG and TODO cleanup by harmonizing release notes and tasks with the shipped changes. This polishes the CHANGELOG voice and cleans up TODOS to ensure the project narrative remains consistent with the latest code state.

When do I need to use automated documentation syncing for project files?

You need automated documentation syncing when you are asked to update the docs, sync documentation, or perform post-ship docs maintenance after a PR merge or release. It proactively applies minor doc tweaks to keep core files aligned with shipped changes.

Does post-ship documentation editing work with gstack tooling for multi-repo projects?

Post-ship documentation editing operates with gstack tooling to perform deterministic edits across multi-repo projects. It reads project docs, cross-references diffs, and updates core files to satisfy requirements for reflecting shipped changes accurately within PR workflows.