document-release

Updates project docs and changelog after code ships.

Updated Mar 24, 2026
One-click install
npx skills add https://github.com/pistosmin/base-one --skill document-release-pistosmin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/pistosmin/base-one/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/pistosmin/base-one --skill document-release-pistosmin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the post-ship documentation maintenance by aligning project docs with what shipped, reducing drift and manual cleanup after PRs.

Core Features & Use Cases

  • Auto-syncs README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.
  • Polishes the CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION.
  • Runs as part of the post-release workflow to ensure documentation parity across the project.

Quick Start

Trigger the document-release skill after a PR ships to refresh docs and align them with the latest release.

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 PR merge?

To automate documentation updates after a PR merge, trigger the skill to cross-check ship diffs against existing docs and automatically refresh README.md, ARCHITECTURE.md, and CLAUDE.md to reflect the latest shipped changes.

What is the best way to keep a CHANGELOG polished and aligned with shipped changes?

Keeping a CHANGELOG polished and aligned with shipped changes is done by running the skill post-release to refine the CHANGELOG voice, clean up pending TODOS, and optionally bump the project VERSION.

How does documentation-sync work for post-ship project maintenance?

Documentation-sync for post-ship maintenance works by assuming write-access to project docs, cross-checking ship diffs, and updating CONTRIBUTING.md and other core documentation files to align with the current release.

Can I automatically bump the VERSION file when documentation is synced?

Yes, you can automatically bump the VERSION when documentation is synced by enabling the optional version-bump feature during the post-release documentation alignment process.

When should I run a post-release documentation update?

You should run a post-release documentation update immediately after code ships or a PR merges to prevent documentation drift and ensure README.md and ARCHITECTURE.md accurately reflect the current state of the project.