document-release

Updates project documentation to match shipped code changes after a release.

Updated Jun 16, 2026
One-click install
npx skills add https://github.com/adamtpang/summon.company --skill document-release-adamtpang
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/adamtpang/summon.company/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/adamtpang/summon.company --skill document-release-adamtpang

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After shipping code, project documentation (README, ARCHITECTURE, CONTRIBUTING, CHANGELOG, TODOS) often drifts out of sync with what actually shipped. This Skill audits every doc against the release diff and brings them back into alignment. ## Core Features & Use Cases - Per-file documentation audit: Cross-references README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md against the git diff, auto-applying factual fixes and asking before risky narrative changes. - Diataxis coverage map and CHANGELOG polish: Builds a reference/how-to/tutorial/explanation coverage map, detects architecture diagram drift, and polishes CHANGELOG voice with a sell-test rubric without clobbering existing entries. - Release bookkeeping: Cleans up TODOS.md, optionally bumps VERSION with explicit confirmation, commits doc changes, and updates the PR/MR body and title with a documentation debt summary. - Use Case: After merging a feature branch, run the skill to sync all docs with the shipped diff, surface undocumented public surface as documentation debt in the PR body, and commit the updates. ## Quick Start Ask the assistant to update the docs and sync documentation for everything that shipped on this branch.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update documentation after shipping code?

Invoke the skill after a PR is merged or code ships. It reads the branch diff, audits each documentation file against what changed, auto-applies factual fixes, and asks before making narrative or structural changes.

How does the skill decide which doc changes to auto-apply?

Factual corrections clearly warranted by the diff, such as updating a file path, count, or table entry, are auto-applied. Narrative changes, section removals, security model edits, and rewrites over roughly ten lines require explicit user approval.

Will it rewrite or delete my existing CHANGELOG entries?

No. The skill only polishes wording within existing entries using exact-match edits and never deletes, reorders, or regenerates entries. If an entry looks wrong or incomplete, it asks the user instead of silently fixing it.

Does it work with GitLab merge requests as well as GitHub PRs?

Yes. The skill detects the platform and uses gh for GitHub or glab for GitLab to update the PR/MR body with a Documentation section and sync the title with the current VERSION prefix.

What happens if the Codex CLI is not installed for the doc review?

The cross-model documentation review falls back to a Claude subagent when Codex is missing or unauthenticated. The review is informational only and never edits docs without user approval.