document-release

Scan project files and diffs to update documentation after shipping.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift. This skill automates aligning docs with shipped changes across the repository by reading the latest code and diffs and updating the docs accordingly.

Core Features & Use Cases

  • Auto-syncs README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes
  • Polishes CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION
  • Proactively suggests documentation updates after PR merges or code ships

Quick Start

Run the document-release skill after shipping to ensure the docs reflect the latest state of the project.

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 for my codebase?

Automate post-ship documentation updates by scanning project files and diffs to align docs with shipped changes. This skill updates README.md, ARCHITECTURE.md, and other core docs after code ships.

What is the best way to keep a CHANGELOG updated after merging a PR?

Polish CHANGELOG voice and clean up TODOS automatically by reading the latest code diffs. This skill proactively suggests documentation updates after PR merges to ensure accurate post-ship notes.

How does documentation drift automation handle README and ARCHITECTURE files?

Documentation drift automation handles README and ARCHITECTURE files by scanning project diffs and syncing the content to reflect shipped changes. This ensures core docs accurately match the latest project state.

Can I automatically bump a VERSION file and polish documentation prose together?

Yes, you can automatically bump VERSION and polish documentation prose together. The skill orchestrates a robust end-to-end workflow that aligns shipped code changes with your repository's documentation.

Do I need specific shell tools to automate syncing my CONTRIBUTING.md with shipped changes?

Yes, you need specific shell tools and repository scripts to automate syncing CONTRIBUTING.md with shipped changes. The skill describes dependencies on these shell tools to orchestrate the end-to-end documentation workflow.