document-release

Sync shipped code changes into repository documentation files.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are tedious and drift out of sync with shipped code. This skill reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION.

Core Features & Use Cases

  • Syncs shipped changes into documentation to keep docs current across the repository.
  • Polishes CHANGELOG and cleans up TODOS to reflect the release.
  • Optionally bumps the VERSION to align with the shipped code.

Quick Start

Run the document-release workflow after shipping to update the docs across the repository.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automatically update documentation after a git merge or code ship?

To automatically update documentation after a git merge, you can use a post-ship workflow that cross-references the PR diff to sync changes into README, ARCHITECTURE, and CONTRIBUTING files. This ensures your repository docs reflect the latest shipped code without manual edits.

What is the best way to keep markdown docs in sync with shipped code changes?

The best way to keep markdown docs in sync with shipped code is to automate the cross-referencing of git diffs against your repository documentation. This approach updates key markdown files and polishes the changelog voice to match the exact release details.

How do I clean up TODOS and polish changelog entries after a release?

To clean up TODOS and polish changelog entries after a release, an automated documentation workflow reads the shipped diff, updates pending TODOS, and refines the changelog voice to accurately reflect the completed work.

Can I automatically bump the version number in my repository after merging a PR?

Yes, you can automatically bump the version number in your repository after merging a PR. A post-ship documentation workflow can optionally update the VERSION file to align with the newly shipped code changes.

Does post-ship documentation automation work with CLAUDE.md files?

Yes, post-ship documentation automation works with CLAUDE.md files. The workflow reads the shipped diff and syncs updates across standard markdown docs, explicitly including CLAUDE.md to ensure your project context stays current.

When should I use an automated workflow to update repository documentation?

You should use an automated workflow to update repository documentation when you want to prevent post-ship docs from drifting out of sync with shipped code. It is ideal for cross-referencing git diffs, polishing changelogs, and bumping versions immediately after a release.