document-release

Update core project docs after merged changes with diff analysis.

Updated Apr 6, 2025
One-click install
npx skills add https://github.com/yolopunk/jedi --skill document-release-yolopunk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/yolopunk/jedi/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/yolopunk/jedi --skill document-release-yolopunk

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts after changes are shipped. This Skill reads merged changes, cross-references the diff, and updates core docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md) to reflect what shipped, ensuring consistency across the project.

Core Features & Use Cases

  • Automated doc synchronization: reads the diff from the merged PR and updates the documented state across key files.
  • CHANGELOG polish and TODOS cleanup: tidies up narrative, tone, and minor TODOs to reflect shipped work.
  • Optional version bump handling: proposes or applies a version bump when documentation changes warrant it.

Quick Start

Run this skill after a PR is merged to automatically update and polish docs across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I keep documentation in sync after merging a PR?

To keep documentation in sync after merging a PR, you can analyze the merged diff and automatically update core docs like README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to accurately reflect the shipped changes.

What is the best way to automate post-ship CHANGELOG updates?

Automating post-ship CHANGELOG updates involves reading merged changes, polishing the narrative and tone, and cleaning up minor TODOs so the changelog accurately reflects the shipped work without manual rewriting.

Can I apply a version bump automatically when documentation changes warrant it?

Yes, you can apply or propose a version bump automatically when documentation changes warrant it, integrating the version update directly into the post-release workflow alongside the doc synchronization process.

Does this documentation update process include validation and dry-run options?

Yes, the documentation update process includes validation and dry-run options to ensure safe version-control actions, allowing you to preview multi-file markdown edits before applying them to the repository.

When do I need to run post-ship documentation synchronization?

You need to run post-ship documentation synchronization immediately after a PR is merged, ensuring consistency across critical project files like README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md before the next development cycle begins.