document-release

Update project docs by cross-referencing diffs after PR merges.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates can be tedious and error-prone. This skill reads all project docs, cross-references the diff, and updates docs to reflect what shipped, while also polishing CHANGELOG, TODOS, and potentially bumping the VERSION.

Core Features & Use Cases

  • Cross-checks and updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.
  • Polishes CHANGELOG voice and tidies TODOS to keep the project history clean.
  • Optional: bump VERSION when documentation changes justify a new release.

Quick Start

Run the document-release skill on a feature branch after a PR is merged to refresh docs.

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 merging a PR?

Automate documentation updates after a PR merge by cross-referencing git diffs against project docs. This skill reads README, ARCHITECTURE, and CONTRIBUTING files to apply changes idempotently using repository tooling.

What is the best way to keep a CHANGELOG updated when shipping new code?

Keeping a CHANGELOG updated when shipping code is best handled by parsing PR diffs and polishing the changelog voice automatically. This skill tidies TODOS and revises project docs to reflect exactly what shipped.

Can I automatically bump a VERSION file based on documentation changes?

Yes, you can automatically bump a VERSION file. When documentation changes justify a new release, this skill optionally increments the version alongside updating README and ARCHITECTURE files.

Does this documentation tool update CLAUDE.md and other project docs idempotently?

Yes, this documentation tool updates CLAUDE.md idempotently. It uses Bash and repository tooling to read docs, parse diffs, and apply changes across README, ARCHITECTURE, and CONTRIBUTING files without duplicate entries.

How do diff parsers sync shipped code changes with existing project documentation?

Diff parsers sync shipped changes by cross-referencing merged code differences against existing project documentation. This skill reads your docs, identifies gaps, and applies targeted updates to reflect the new state.

When should I run a post-ship documentation refresh on my feature branch?

Run a post-ship documentation refresh on your feature branch immediately after a PR is merged. This ensures README, CHANGELOG, and TODOS accurately reflect the shipped changes before the next development cycle.