document-release

Align project documentation with shipped changes by diffing the base branch.

1|Updated Mar 1, 2026
One-click install
npx skills add https://github.com/anishs1207/agentic-cli --skill document-release-anishs1207
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/anishs1207/agentic-cli/tree/main/.agents/skills/gstack-document-release
Command: npx skills add https://github.com/anishs1207/agentic-cli --skill document-release-anishs1207

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation tends to fall out of date. This Skill reads all project docs, cross-references diffs, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to reflect what shipped, polishes CHANGELOG, cleans up TODOS, and optionally bumps VERSION. Use when you need to "update the docs", "sync documentation", or "post-ship docs".

Core Features & Use Cases

  • Automatically reconciles documentation with the latest shipped changes by reading the diff and updating key docs.
  • Applies diff-based updates across core docs (README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, and CHANGELOG.md).
  • Optionally bumps VERSION when changes warrant it, preserving changelog history and traceability.
  • Provides a consistent, user-friendly editorial polish and workflow for post-release documentation.

Quick Start

Tell me to run document-release after a PR ships to refresh and align all docs with the latest changes.

Frequently Asked Questions about document-release

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

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

Automatically update documentation after a release by diffing the base branch against shipped changes and applying targeted updates to README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, and CHANGELOG.md. The skill enforces editorial polish, consistency, and traceability across all modified docs.

What is the best way to keep project docs in sync with shipped code changes?

Keeping project docs in sync involves reading the post-merge diff, cross-referencing it with existing documentation, and rewriting stale sections to reflect what shipped. This skill automates that reconciliation, cleans up lingering TODOs, and optionally bumps the VERSION file.

Can I use this to polish a CHANGELOG.md and bump VERSION at the same time?

Yes, you can polish CHANGELOG.md and bump VERSION simultaneously. The skill reads the shipped diff, applies editorial polish to the changelog for consistency, optionally increments the VERSION file when changes warrant it, and preserves full changelog history and traceability.

Does this documentation sync tool require any specific dependencies or components?

No dependencies or components are required to run this documentation sync tool. It operates independently by reading the base branch diff and applying editorial updates directly to core project docs without needing external libraries or frameworks.

How does diffing the base branch work for updating README and ARCHITECTURE docs?

Diffing the base branch works by comparing the shipped code changes against the main branch, identifying relevant updates, and applying those changes contextually to README.md and ARCHITECTURE.md. Risky changes are surfaced separately for user approval before any doc modifications are committed.

When should I run post-ship documentation updates instead of manual editing?

Run post-ship documentation updates instead of manual editing when a PR ships and multiple core docs need reconciliation. It prevents drift by automatically cross-referencing diffs with README, ARCHITECTURE, CONTRIBUTING, CLAUDE, and CHANGELOG files, which is error-prone when done manually.