document-release

Update project documentation files to reflect shipped changes after PR merges.

1|Updated Apr 26, 2026
One-click install
npx skills add https://github.com/tblakex01/conductor-playground --skill document-release-tblakex01
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/tblakex01/conductor-playground/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/tblakex01/conductor-playground --skill document-release-tblakex01

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill reads shipped changes, cross-references the diff, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what shipped. It also polishes the CHANGELOG and cleans up TODOS, and can optionally bump the VERSION after a release.

Core Features & Use Cases

  • Automated cross-file documentation updates across key project docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md) to reflect shipped changes.
  • CHANGELOG polishing, tone normalization, and TODO cleanup to maintain a clean release narrative.
  • Optional version bump and deterministic documentation refresh after PR merges or code shipping, ensuring docs stay in sync with the codebase.

Quick Start

Invoke the document-release skill after shipping to update docs, polish the changelog, 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 update README and CLAUDE.md automatically after a PR is merged?

To update README and CLAUDE.md after a PR is merged, you can use a post-ship documentation sync tool that cross-references the shipped diff and modifies repository files to reflect the new changes.

What is the best way to keep project documentation in sync with shipped code changes?

Keeping project documentation in sync with shipped code changes involves cross-referencing diffs to automatically update README, ARCHITECTURE, and CONTRIBUTING files so the docs accurately reflect what was actually deployed.

How do I polish a CHANGELOG and clean up TODOS before a version bump?

Polishing a CHANGELOG and cleaning up TODOs before a version bump requires normalizing the release narrative tone and clearing completed items, which can be automated using bash and file editing tooling.

Can I automatically bump the VERSION file and update architecture docs at the same time?

Yes, you can automatically bump the VERSION file and update architecture docs simultaneously by invoking a deterministic documentation refresh that reads shipped changes and modifies the repository files in one pass.

When do I need to sync documentation after shipping code?

You need to sync documentation after shipping code whenever a merged PR introduces changes that alter the project's behavior, ensuring the README, ARCHITECTURE, and CLAUDE.md files do not become stale.

Does post-ship documentation sync work without external dependencies?

Yes, post-ship documentation sync works without external dependencies by using built-in bash and file read/write/edit tooling to directly modify repository files like CLAUDE.md and CONTRIBUTING docs.