document-release

Update repository documentation to match shipped code and recent diffs.

Updated Mar 30, 2026
One-click install
npx skills add https://github.com/GenEducation/GenedUIProject --skill document-release-geneducation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/GenEducation/GenedUIProject/tree/main/.gemini/skills/document-release
Command: npx skills add https://github.com/GenEducation/GenedUIProject --skill document-release-geneducation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill keeps project documentation aligned with what actually shipped, so teams do not leave stale README files, outdated contributor guides, or misleading release notes behind after code changes land.

Core Features & Use Cases

  • Doc-to-code sync: Reads the repo’s docs and cross-checks them against the latest diff so instructions, paths, and references match reality.
  • Post-ship cleanup: Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md when the shipped behavior changed, and polishes CHANGELOG wording without rewriting history.
  • Release hygiene: Cleans up TODOs, flags risky narrative changes, and asks before version bumps or other decisions that need human judgment.
  • Use case: After a PR merges, use this Skill to make sure the docs tell the same story as the code, not the story from last week’s branch.

Quick Start

Ask this Skill to review the repository after a ship and update every affected Markdown file so the documentation matches the code that actually landed.

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 to match shipped code after a merge?

To update repository documentation to match shipped code, you need to cross-check existing docs against the latest diff and apply changes to affected files. This skill reads recent diffs to update README, architecture notes, and contributor guides so instructions match reality.

What is the best way to keep changelog wording accurate without rewriting history?

The best way to keep changelog wording accurate is to preserve existing content while validating factual changes and cross-references. This approach polishes release notes and flags risky narrative changes without overwriting previous entries.

Can I automatically sync README and contributor guides when post-release behavior changes?

Yes, you can sync README and contributor guides when post-release behavior changes by analyzing the shipped diff. The process updates affected Markdown files like CONTRIBUTING and CLAUDE.md to ensure they reflect the newly landed code.

Does post-ship documentation cleanup handle TODO removal and version bump validations?

Post-ship documentation cleanup does handle TODO removal and version bump validations by cleaning up stale items and asking for human judgment before applying version-related decisions. This ensures release hygiene without automated overrides.

When do I need to sync architecture notes and agent instructions after a release?

You need to sync architecture notes and agent instructions after a release whenever the shipped behavior changed the codebase. Running a doc-to-code sync ensures that cross-references and path instructions match the actual merged code.