skills.rest
FxHollow
FxHollowCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update core docs and CHANGELOG from project diffs after release.

Updated Mar 26, 2026
Search Tags:#automation#documentation#CHANGELOG#release-notes#READMEs#diff-sync
One-click install
npx skills add https://github.com/FxHollow/100000mrr-landing --skill document-release-fxhollow
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/FxHollow/100000mrr-landing/tree/main/.agents/skills/gstack/document-release
Command: npx skills add https://github.com/FxHollow/100000mrr-landing --skill document-release-fxhollow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift: when code ships, READMEs and docs may go out of sync. This Skill reads project docs, cross-references diffs, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to reflect what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION. It helps ensure documentation stays accurate and aligned with shipped content.

Core Features & Use Cases

  • Automated doc synchronization: updates key docs to match shipped changes.
  • CHANGELOG polishing and TODOS cleanup: keeps release notes tidy and actionable.
  • Optional version bump: bump VERSION when appropriate after changes.
  • Proactive suggestions after PR merges or code ships.

Quick Start

Run document-release after a PR merge to synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes and polish release notes.

Frequently Asked Questions about document-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep README and documentation in sync with shipped code changes?▼

To keep documentation in sync with shipped code changes, automate post-ship doc alignment by reading project diffs and updating README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to accurately reflect the shipped content.

How do I automate CHANGELOG updates after a PR merge?▼

Automate CHANGELOG updates after a PR merge by applying diff-sync to polish the release notes language, clean up TODOS, and optionally bump VERSION, ensuring release notes remain tidy and actionable.

What is documentation drift and how do I prevent it?▼

Documentation drift happens when shipped code changes cause READMEs and docs to go out of sync. Prevent it by running automated diff-sync updates after code ships to align core documentation with the actual codebase.

Can I automatically update CLAUDE.md and CONTRIBUTING files when code ships?▼

Yes, you can automatically update CLAUDE.md and CONTRIBUTING files when code ships by reading project diffs and cross-referencing them to update key documentation, ensuring doc accuracy across the codebase.

What is the best way to clean up TODOS and polish release notes?▼

The best way to clean up TODOS and polish release notes is to run an automated post-ship documentation update that applies diff-sync, tidying TODOS and refining CHANGELOG voice for actionable release notes.

Related Skills

Explore More Content & Communication Skills→
mgher668mgher668

document-release

Synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped diffs.

Community
Advanced
t0labt0lab
2

release

Analyze Conventional Commits to draft changelogs and create release commits and tags.

Official
Advanced
imonmiimonmi

document-release

Update project documentation to match shipped code changes from diffs.

Community
Advanced
thanh-abaiithanh-abaii
34

gs:document-release

Automate post-ship documentation updates by comparing diffs and revising READMEs and CHANGELOGs.

Community
Advanced