skills.rest
shihwesley
shihwesleyCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update Markdown documentation and changelog after a release.

Updated Mar 16, 2026
Search Tags:#workflow#versioning#documentation#release#diff#CHANGELOG#polish
One-click install
npx skills add https://github.com/shihwesley/shihwesleys-harness --skill document-release-shihwesley
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/shihwesley/shihwesleys-harness/tree/main/skills/gstack/document-release
Command: npx skills add https://github.com/shihwesley/shihwesleys-harness --skill document-release-shihwesley

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Post-ship documentation update requires aligning README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with what shipped; this Skill automates cross-file synchronization to keep docs accurate and consistent.

Core Features & Use Cases

  • Auto-sync documentation: updates key docs to reflect shipped changes.
  • CHANGELOG polishing: refines narration without overwriting existing entries.
  • Optional version bump: suggests and applies a version bump when appropriate and prepares a PR body with the diff preview.

Quick Start

Run document-release after shipping to automatically align docs and prep a PR with the diff preview.

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

Automate documentation updates after a release by running this Skill to diff shipped content against core Markdown files like README.md and ARCHITECTURE.md, then automatically adjusting prose and references to reflect actual changes.

What is the best way to keep a CHANGELOG up to date without overwriting old entries?▼

Keep a CHANGELOG up to date by polishing new narration entries while preserving existing changelog entries. The Skill refines the release narrative without overwriting historical changes, maintaining a continuous and accurate versioning record.

Can I automatically bump the version number when syncing shipped documentation?▼

Yes, you can automatically bump the version number when syncing shipped documentation. The Skill suggests and applies a version bump when appropriate, then prepares a pull request body with a diff preview.

Does this documentation sync tool require a local repository context?▼

Yes, this documentation sync tool requires a local repository context to function. It reads diffs directly from the local repository to identify necessary adjustments across multiple Markdown files, including CONTRIBUTING.md and CLAUDE.md.

How do I prepare a PR body with a diff preview for post-ship documentation?▼

Prepare a PR body with a diff preview for post-ship documentation by running the Skill after shipping. It aligns core docs with the shipped changes, optionally bumps the version, and generates a pull request body containing the diff preview.

Related Skills

Explore More Content & Communication Skills→
k97k97
4

git-commit

Analyzes git diffs to generate standardized conventional commit messages.

Community
Intermediate
hadpadrahulhadpadrahul

gsd-ship

Automate GitHub pull request creation, reviewer assignment, and merge preparation.

Community
Advanced
webdriveriowebdriverio
11

Global Coding Style

Enforce global coding style conventions across codebases during file creation or modification.

Official
Basic
zzafergokzzafergok
1

markdown-to-html-skill

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

Community
Intermediate