skills.rest
effiraid
effiraidCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Sync README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes.

Updated Aug 23, 2026
Search Tags:#documentation#CHANGELOG#docs-sync#version-bump#post-ship#TODOS
One-click install
npx skills add https://github.com/effiraid/reflix-nextjs --skill document-release-effiraid
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/effiraid/reflix-nextjs/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/effiraid/reflix-nextjs --skill document-release-effiraid

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are tedious and error-prone. This Skill reads the project docs, cross-references the diff, and updates core files to reflect what shipped, ensuring readers see accurate guidance.

Core Features & Use Cases

  • Reads diffs from the active release and identifies changes that affect README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.
  • Updates the referenced docs to match shipped changes, preserving consistency across the project.
  • Polishes CHANGELOG narration, cleans up TODOS, and optionally bumps the version number when appropriate.
  • Proactively suggests documentation updates after a PR is merged or code is shipped.

Quick Start

Run document-release after shipping to refresh and synchronize docs across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

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 shipping a release?▼

You can automate post-ship documentation updates by analyzing release diffs and syncing changes across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md. This ensures core docs accurately reflect shipped code changes without manual effort.

What is the best way to keep a CHANGELOG and TODOS updated after a PR merge?▼

The best way to keep a CHANGELOG and TODOS updated after a PR merge is to run an automated post-ship sync. It polishes changelog narration, cleans up TODOS, and optionally applies a version bump based on the merged diff.

How does syncing docs across README and CLAUDE.md based on a diff work?▼

Diff-based doc syncing works by reading the active release diff, cross-referencing it against existing project files, and applying targeted edits. It updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match the shipped changes.

Can I automatically bump the version number when updating project documentation?▼

Yes, you can automatically bump the version number when updating project documentation. The post-ship update process supports optional version bumps alongside cleaning up TODOS and polishing the CHANGELOG narration.

Do I need to manually trigger documentation sync after every code release?▼

No, you do not need to manually trigger documentation sync after every release. The process supports interactive prompts to proactively suggest and run documentation updates automatically after a PR is merged or code is shipped.

Related Skills

Explore More Content & Communication Skills→
fray-cloudfray-cloud

document-release

Automates updating project docs after inspecting committed code changes.

Community
Advanced
datheredathere
3.7k

release-prep

Bump version numbers across qsv files and update the changelog for release preparation.

Official
Advanced
zz8011zz8011

document-release

Sync project documentation with shipped code changes after a PR merge.

Community
Advanced
ajsai47ajsai47
11

document-release

Update project markdown documentation by cross-referencing git diffs after code commits.

Community
Advanced