document-release

Update core project docs to reflect shipped changes.

Updated Feb 28, 2026
One-click install
npx skills add https://github.com/Analog-Labs/pixelport-launchpad --skill document-release-analog-labs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Analog-Labs/pixelport-launchpad/tree/main/.agents/skills/gstack/document-release
Command: npx skills add https://github.com/Analog-Labs/pixelport-launchpad --skill document-release-analog-labs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from what was actually shipped. This Skill reads all project docs, compares them to the latest changes, and updates the core files to reflect what shipped.

Core Features & Use Cases

  • Keeps README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md in sync with the shipped state.
  • Polishes CHANGELOG voice and tidies TODOS to keep release notes accurate.
  • Helps manage VERSION bump decisions when appropriate to avoid drift.

Quick Start

Run document-release to synchronize and polish shipped documentation 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 merging a PR?

To update documentation after a PR, run document-release to compare project diffs against existing docs and automatically sync README, ARCHITECTURE, and CONTRIBUTING files with the shipped code changes.

How do I keep my CHANGELOG and project docs in sync with code changes?

Keeping CHANGELOG and project docs in sync is done by cross-referencing shipped diffs to polish release notes, clean up TODOS, and update core documentation files to accurately reflect the latest version.

Can I automatically bump my project VERSION when code is shipped?

Yes, you can manage VERSION bump decisions automatically. The skill evaluates shipped changes and optionally bumps VERSIONs when appropriate to prevent documentation and release state drift.

What is the best way to polish release notes and clean up TODOS after a ship?

The best way to polish release notes is to cross-reference the latest diff against project docs, which refines the CHANGELOG voice and tidies TODOS for accurate release documentation.

Does this documentation sync tool require specific dependencies to run?

No specific dependencies are required to run this documentation sync tool. It operates independently to read project files, compare them to the latest ship, and update core docs.

When should I avoid automatic documentation updates after a release?

You should avoid automatic documentation updates if your project requires manual review of release notes or if your docs are managed outside the core README, ARCHITECTURE, CONTRIBUTING, and CLAUDE files.