document-release

Update project docs from diffs after code ships.

Updated Feb 16, 2026
One-click install
npx skills add https://github.com/SeaLion-hub/DICEE --skill document-release-sealion-hub
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/SeaLion-hub/DICEE/tree/main/.agents/skills/gstack/document-release
Command: npx skills add https://github.com/SeaLion-hub/DICEE --skill document-release-sealion-hub

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reads diffs from shipping changes and updates the project docs to reflect what was actually released, reducing drift between code and documentation.

Core Features & Use Cases

  • Updates core docs like README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to match shipped changes.
  • Polishes CHANGELOG wording without overwriting existing entries.
  • Cleans up TODOS and optionally bumps the VERSION when appropriate.

Quick Start

Run the document-release workflow after shipping to ensure docs stay in sync 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 update project documentation to match shipped code changes?

To update project documentation after shipping, you can use a post-ship docs sync workflow that reads code diffs and updates core docs like README.md and ARCHITECTURE.md to reflect the actual released changes, reducing drift between code and documentation.

What is the best way to keep README and ARCHITECTURE docs in sync with merged PRs?

Keeping README and ARCHITECTURE docs in sync with merged PRs is best handled by applying diff data to the doc structure after code ships, safely updating core files to accurately reflect the latest shipped changes.

Can I automatically update CHANGELOG entries and clean up TODOS from code diffs?

Yes, you can automatically update CHANGELOG entries and clean up TODOS by reading diff data from shipped changes. The process polishes CHANGELOG wording without overwriting existing entries and organizes TODOs based on the diff output.

When do I need to bump the VERSION file during a documentation sync?

You need to bump the VERSION file during a documentation sync when a shipped code change warrants a version increment. The post-ship docs sync process can optionally bump the VERSION when appropriate based on the diff data.

Does this docs sync workflow work with CONTRIBUTING.md and CLAUDE.md files?

Yes, this docs sync workflow works with CONTRIBUTING.md and CLAUDE.md files. It reads diff data from shipped changes and applies updates across these core docs to ensure the entire project documentation stays aligned with the code.