skills.rest
tyhuffman7
tyhuffman7COMMUNITY
Explore all skills by this author →
GitHub

document-release

Align project documentation with shipped changes by reading diffs.

1|Updated Apr 15, 2026
Search Tags:#changelog#versioning#documentation#readme#claude.md#docs-sync#post-ship
One-click install
npx skills add https://github.com/tyhuffman7/gstack-hermes --skill document-release-tyhuffman7
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/tyhuffman7/gstack-hermes/tree/main/gstack-document-release
Command: npx skills add https://github.com/tyhuffman7/gstack-hermes --skill document-release-tyhuffman7

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates post-ship documentation updates by aligning project docs with the shipped changes.

Core Features & Use Cases

  • Reads project docs, cross-references diffs, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect the shipped content.
  • Polishes CHANGELOG wording, cleans up TODOS, and optionally bumps the VERSION after a PR is merged.
  • Uses when asked to "update the docs", "sync documentation", or "post-ship docs" to ensure docs stay current.

Quick Start

Run the post-ship doc sync to align project docs with shipped changes and optionally bump the version.

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 after a PR is merged?▼

Post-ship documentation updates are automated by reading project diffs and aligning files like README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect the shipped state.

How do I sync my README and CHANGELOG with shipped code changes?▼

Sync README and CHANGELOG content by cross-referencing shipped diffs against existing project docs, polishing changelog wording, and cleaning up TODOS to match the current state.

Can I automatically bump the VERSION file when updating post-ship docs?▼

Version bumping is supported as an optional step during the post-ship documentation sync process, allowing you to update the VERSION file alongside the documentation cleanup.

When should I run a documentation sync for my project?▼

Documentation sync should be run when asked to update the docs, sync documentation, or handle post-ship docs after a PR is merged to ensure project documentation stays current.

Does this documentation update tool work without external dependencies?▼

The documentation update process operates without external dependencies, reading existing project docs and diffs directly to align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files.

What is the best way to keep CLAUDE.md aligned with shipped project changes?▼

Keeping CLAUDE.md aligned is handled by reading shipped diffs and updating the file content to reflect the current project state alongside standard documentation like README and ARCHITECTURE.

Related Skills

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

document-release

Automates updating project docs after inspecting committed code changes.

Community
Advanced
ThiagoGuislottiThiagoGuislotti
2

docs-release-engineer

Generate repository documentation and release artifacts with semantic versioning and link validation.

Community
Intermediate
zaxbysaucezaxbysauce
437

commit-pr

Enforce conventional commit formats and PR-quality gates across development workflows.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate