document-release

Update repository docs and CHANGELOG after code ships.

Updated Mar 14, 2026
One-click install
npx skills add https://github.com/EhsaanArk/ai-signal-router --skill document-release-ehsaanark
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/EhsaanArk/ai-signal-router/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/EhsaanArk/ai-signal-router --skill document-release-ehsaanark

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation maintenance across a codebase by synchronizing docs, polishing change logs, and tidying to reflect shipped changes.

Core Features & Use Cases

  • Automatically refresh README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md when new code ships.
  • Polish CHANGELOG language and tidy TODOS to reflect the latest release.
  • Optionally bump the VERSION when changes warrant a new release.

Quick Start

Run /document-release to automatically refresh shipped docs, update cross-file references, and polish the CHANGELOG before releasing.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update repository documentation automatically after a release?

You can update repository documentation automatically after a release by running the document-release process when a PR merges, synchronizing README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped code changes.

What is post-ship documentation maintenance?

Post-ship documentation maintenance is the process of synchronizing Markdown files and polishing a CHANGELOG to reflect newly shipped code changes across a repository.

How do I polish CHANGELOG language and tidy TODOS after shipping code?

To polish CHANGELOG language and tidy TODOS after shipping code, run the document-release workflow which reads repository docs and edits Markdown files to enforce consistent release documentation.

Can I automatically bump the VERSION file when changes warrant a new release?

Yes, you can automatically bump the VERSION file when changes warrant a new release, as the document-release workflow enforces version bump workflows and optionally updates the VERSION file.

Does the documentation synchronization process emit audit logs?

Yes, the documentation synchronization process emits telemetry logs for auditing, allowing you to track the automated updates made to README, ARCHITECTURE, and other Markdown files.