document-release

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

1|Updated Feb 22, 2026
One-click install
npx skills add https://github.com/TarunTeja44/portfolio --skill document-release-tarunteja44
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/TarunTeja44/portfolio/tree/main/.agents/skills/document-release
Command: npx skills add https://github.com/TarunTeja44/portfolio --skill document-release-tarunteja44

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After shipping code, project documentation like README, ARCHITECTURE, CONTRIBUTING, and CHANGELOG often drifts out of sync with what actually shipped. This Skill audits every documentation file against the branch diff and brings them back into alignment before a PR merges. ## Core Features & Use Cases - Diff-driven doc audit: Cross-references the git diff against README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and other Markdown files, auto-applying factual corrections and asking before risky narrative changes. - CHANGELOG voice polish and TODOS cleanup: Rewords existing CHANGELOG entries into user-forward language without altering content, marks completed TODO items, and captures new deferred work found in the diff. - Version and PR integration: Prompts before any VERSION bump, commits doc updates, pushes the branch, and appends a Documentation section with a doc diff preview to the PR body. - Use Case: After merging a feature branch that adds a new command, run this Skill to update the README feature table, fix stale setup steps in CONTRIBUTING, polish the CHANGELOG entry, and commit everything as a single docs commit on the PR. ## Quick Start Ask the assistant to run the document-release workflow to sync all project documentation with the changes on the current feature 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 project documentation after shipping code?

Run the document-release workflow from a feature branch after code is committed. It diffs the branch against the base branch, audits each Markdown file, applies factual fixes automatically, and asks before any risky narrative changes.

How to keep README and CHANGELOG in sync with a release?

The workflow cross-references the git diff with README feature lists and polishes existing CHANGELOG entries for user-forward voice. It never rewrites or deletes CHANGELOG content, only adjusts wording within existing entries.

Does this workflow bump the VERSION file automatically?

No. It never bumps VERSION without asking. If VERSION was already bumped, it verifies the bump covers the full scope of branch changes and prompts when significant changes lack their own version entry.

Can it run on the main or base branch?

No. The workflow aborts if run from the base branch and must be executed from a feature branch. It detects the base branch via an existing PR or the repository default branch.

What happens if no documentation needs changes?

It checks git status before committing and exits with a message that all documentation is up to date, skipping the commit, push, and PR body update entirely.