skills.rest
louisfghbvc
louisfghbvcCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Update project documentation to align with shipped code changes.

4|1|Updated Sep 13, 2023
Search Tags:#documentation#claude#diff#update#CHANGELOG#version
One-click install
npx skills add https://github.com/louisfghbvc/mcp-leetcode-crawler --skill document-release-louisfghbvc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/louisfghbvc/mcp-leetcode-crawler/tree/main/.agent/skills/document-release
Command: npx skills add https://github.com/louisfghbvc/mcp-leetcode-crawler --skill document-release-louisfghbvc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation update. Reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION. Use when asked to "update the docs", "sync documentation", or "post-ship docs". Proactively suggest after a PR is merged or code is shipped. (gstack)

Core Features & Use Cases

  • Reads project docs, cross-references diffs, updates core docs to reflect shipped changes.
  • Polishes CHANGELOG language and tone to match shipped features.
  • Cleans up TODOS and merges relevant TODO items into actionable tasks.
  • Optionally bumps VERSION when requested, and manages versioning notes.
  • Proactively suggests documentation improvements after PRs or code ship.

Quick Start

Run the document-release skill after shipping to update docs across the repo.

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 shipping code changes?▼

To automatically update documentation after shipping, this skill scans your code diff, cross-references it with existing project docs, and updates README, ARCHITECTURE, and CONTRIBUTING files to match the shipped changes.

What is the best way to sync project docs with a merged PR diff?▼

The best way to sync docs with a merged PR is running this skill, which reads the repository diff, aligns core documentation like CLAUDE.md with the new code, and polishes the CHANGELOG wording.

Can I automatically clean up and merge TODO items when updating release notes?▼

Yes, you can clean up and merge TODO items during release notes updates because this skill polishes the CHANGELOG language, cleans up existing TODOs, and consolidates them into actionable tasks.

How do I bump the VERSION file and sync documentation after a release?▼

To bump the VERSION file and sync documentation after a release, run this skill in your repository workspace; it optionally bumps the version number while simultaneously aligning all core docs with the shipped changes.

Does this documentation sync tool require access to the repository workspace?▼

Yes, this documentation sync tool requires direct access to the repository workspace because it needs to read the current project docs and code diff, then modify the README, CHANGELOG, and version files.

When should I use an automated post-ship documentation update process?▼

You should use an automated post-ship documentation update process immediately after a PR is merged or code is shipped, ensuring your README, ARCHITECTURE, and CHANGELOG accurately reflect the latest features without manual effort.

Related Skills

Explore More Content & Communication Skills→
bajajvinamrbajajvinamr

document-release

Sync README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes.

Community
Intermediate
drgon1drgon1
1

github-skill-publisher

Publish and update GitHub Skill repositories with standardized documentation and conventional commits.

Community
Intermediate
mattothomasmattothomas

ship

Automate the end-to-end shipping pipeline from merge to pull request.

Community
Advanced
shekerkammashekerkamma

document-release

Update project documentation to match shipped code changes.

Community
Advanced