skills.rest
steadyfall
steadyfallCOMMUNITY
Explore all skills by this author →
Website𝕏@steadyfall04GitHub

document-release

Cross-references diffs and updates shipped documentation to reflect changes.

Updated Mar 28, 2026
Search Tags:#automation#documentation#diff#CLAUDE.md#CHANGELOG#docs-sync#version-bump
One-click install
npx skills add https://github.com/steadyfall/fspeek --skill document-release-steadyfall
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/steadyfall/fspeek/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/steadyfall/fspeek --skill document-release-steadyfall

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often lags behind code changes, leaving README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md out of sync and the CHANGELOG stale.

Core Features & Use Cases

  • Reads project docs, cross-references diffs, and updates documentation to reflect what shipped.
  • Polishes CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION based on shipped changes.
  • Triggered by requests like "update the docs", "sync documentation", or "post-ship docs" to ensure repo-wide consistency across teams.

Quick Start

Ask me to run document-release after a PR is merged to refresh the repository docs.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I sync repository documentation after merging a PR?▼

To sync repository documentation after a PR, you can trigger an automated post-ship workflow to read project docs, cross-reference code diffs, and update README, ARCHITECTURE, and CONTRIBUTING files to reflect the shipped changes.

What is the best way to keep CLAUDE.md and CHANGELOG updated with code changes?▼

Keeping CLAUDE.md and CHANGELOG updated relies on cross-referencing code diffs against existing docs to polish the CHANGELOG voice and ensure repo-wide consistency across teams without manual intervention.

Can I automatically bump the VERSION and clean up TODOS when shipping?▼

Yes, you can automatically bump the VERSION and clean up TODOS when shipping by applying an automated process that reads project diffs and optionally updates version control files based on the shipped changes.

Does post-ship docs sync require any dependencies to run?▼

Post-ship docs sync requires no external dependencies, using internal gstack tooling to perform automated reads, edits, and commits with proper version control directly within your repository environment.

When do I need to run a post-ship documentation update?▼

You need to run a post-ship documentation update when repository docs lag behind code changes, leaving README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md out of sync and the CHANGELOG stale after merging.

Related Skills

Explore More Content & Communication Skills→
fghaffarfghaffar

document-release

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

Community
Advanced
ShareXShareX
309

ShareX Workflow and Versioning

Standardizes Git commits/pushes and Directory.Build.props versioning for the XerraS repo.

Official
Advanced
sobhanashinesobhanashine
1

land-and-deploy

Automate code merge, CI/CD pipeline, and production health verification workflows.

Community
Intermediate
wodehwodeh

document-release

Automate post-ship documentation updates by scanning diffs and aligning project docs.

Community
Advanced