skills.rest
JonOlsenCa
JonOlsenCaCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Update project documentation from diffs after PR merges.

Updated Aug 23, 2026
Search Tags:#automation#git#documentation#release#docs#CLAUDE.md#CHANGELOG
One-click install
npx skills add https://github.com/JonOlsenCa/gstack-main --skill document-release-jonolsenca
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/JonOlsenCa/gstack-main/tree/main/document-release
Command: npx skills add https://github.com/JonOlsenCa/gstack-main --skill document-release-jonolsenca

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts after release. This skill automates reading project docs, cross-referencing diffs, and updating key documents (READMEs, ARCHITECTURE, CONTRIBUTING, CLAUDE.md) to reflect what shipped, polishing CHANGELOG voice, cleaning up TODOS, and optionally bumping VERSION.

Core Features & Use Cases

  • Auto-synchronizes docs after a release by aligning READMEs and architecture notes with merged changes.
  • Rewrites or polishes CHANGELOG voice and updates TODOS to reflect shipped changes.
  • Optional version bump and proactive documentation hygiene across CLAUDE.md and project docs for teams shipping software (gstack).

Quick Start

Run the document-release skill after a PR is merged to refresh all docs to reflect the shipped changes.

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

Automate documentation updates after a git release by reading project diffs to align READMEs, ARCHITECTURE, and CONTRIBUTING files with shipped changes. This ensures docs stay accurate and eliminates manual post-merge edits.

What is the best way to keep CLAUDE.md and CHANGELOG in sync with merged PRs?▼

Keep CLAUDE.md and CHANGELOG in sync by applying project diffs to polish CHANGELOG voice and update project docs automatically. This maintains documentation hygiene across your repository after every PR merge.

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

Yes, you can automatically bump VERSION and clean up TODOS when shipping a release. The skill reads code diffs to update TODO lists and optionally increment version numbers with audit-friendly traces.

Does this documentation automation work without external dependencies?▼

Yes, this documentation automation works without external dependencies. It operates independently to read project diffs and update key documents, requiring no additional components or packages to function.

Why does post-ship documentation drift after merging code changes?▼

Post-ship documentation drifts because manual updates are often skipped after merging code changes. Automating diff analysis prevents this by directly updating READMEs and architecture notes to reflect the actual shipped state.

Related Skills

Explore More Content & Communication Skills→
ever-oliever-oli
3

github-code-review

Analyze git diffs and generate structured inline review comments.

Community
Intermediate
marcel-heinzmarcel-heinz
4

release

Coordinate ClawCity release workflows with version bumps, changelog updates, git tagging, and GitHub releases.

Community
Advanced
mpauloskympaulosky

release-process-base

Automate version bumping, branch merging, tagging, and CI/CD verification for Git-backed releases.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

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

Community
Intermediate