doc-amend

Identify and amend missing documentation files across commits using interactive rebase with per-commit confirmation.

3|Updated Mar 12, 2025
One-click install
npx skills add https://github.com/vlossom-ui/vlossom --skill doc-amend
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-amend
Source: https://github.com/vlossom-ui/vlossom/tree/main/.claude/skills/doc-amend
Command: npx skills add https://github.com/vlossom-ui/vlossom --skill doc-amend

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After commits are split, some documentation files (tests, README, stories, markdown) may be missing. This skill guides you to identify and amend those docs back into the appropriate commits via an interactive rebase with per-commit confirmation.

Core Features & Use Cases

  • Phase-based workflow including commit analysis, documentation drafting, plan confirmation, and per-commit amend.
  • Ensures README, tests, stories, and markdown are added to the correct commits.
  • Supports interactive rebase with user prompts to approve each amendment.

Quick Start

Run /doc-amend HEAD~5 to review and amend missing documentation across the last five commits.

Frequently Asked Questions about doc-amend

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

FAQPage Schema
How do I amend missing documentation files into specific git commits?

To amend missing documentation files into specific git commits, you use an interactive rebase workflow that analyzes commit history, drafts missing README, tests, and markdown files, then prompts you to approve each amendment per commit during the rebase process.

What is the best way to ensure every commit ships with complete documentation in a multi-commit workflow?

The best way to ensure every commit ships with complete documentation is running a phase-based workflow that analyzes commits, drafts missing docs, confirms the plan, and executes an interactive rebase with per-commit prompts to update README, tests, stories, and markdown.

Can I update README and tests across multiple split commits without losing the original commit structure?

Yes, you can update README and tests across split commits without losing the original structure by using an interactive rebase workflow that pauses at each commit to prompt you for confirmation before amending the missing documentation files directly into that specific commit.

How do I review and amend missing documentation across the last five commits?

To review and amend missing documentation across the last five commits, run the doc-amend command with HEAD~5 to initiate commit analysis, draft missing files, confirm the plan, and execute per-commit amendments during an interactive rebase.

What types of documentation files are targeted for commit amendment?

The documentation files targeted for commit amendment include README files, tests, stories, and markdown files that may be missing or incomplete across your split commits in a multi-commit feature, fix, or removal workflow.

When should I use an interactive rebase workflow to amend missing docs?

You should use an interactive rebase workflow to amend missing docs when your project follows a multi-commit feature, fix, or removal workflow where documentation is split across commits and requires per-commit confirmation to ensure complete project docs are shipped.