From 4b2820bdce3cd1238297afef41636e6662a39905 Mon Sep 17 00:00:00 2001 From: Kieran Klaassen Date: Wed, 26 Nov 2025 21:03:22 -0800 Subject: [PATCH] docs: fix workflow command documentation to use correct syntax MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update all documentation to show the correct command syntax: - `/plan`, `/review`, `/work`, `/codify` (short form, autocompletes) Previously showed `/workflows:plan` etc. which doesn't work. The `name:` field in frontmatter determines the short command name. Fixes #19 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- docs/index.html | 127 +++++++++++++++--- docs/pages/changelog.html | 2 +- docs/pages/commands.html | 30 ++--- docs/pages/getting-started.html | 24 ++-- docs/pages/skills.html | 4 +- plans/landing-page-launchkit-refresh.md | 2 +- plugins/compounding-engineering/CHANGELOG.md | 4 +- plugins/compounding-engineering/CLAUDE.md | 2 +- plugins/compounding-engineering/README.md | 10 +- .../commands/generate_command.md | 2 +- .../skills/file-todos/SKILL.md | 2 +- .../skills/git-worktree/SKILL.md | 10 +- 12 files changed, 158 insertions(+), 61 deletions(-) diff --git a/docs/index.html b/docs/index.html index b6cd6d3..ce44208 100644 --- a/docs/index.html +++ b/docs/index.html @@ -21,6 +21,106 @@ + + + @@ -37,9 +137,6 @@ Skills MCP Servers Docs -
@@ -127,7 +224,7 @@

Plan

Stop starting over from scratch

- You know that moment when you open a ticket and think "how did we solve this last time?" The framework-docs-researcher already knows. The git-history-analyzer remembers what worked in March. Run /workflows:plan and three research agents work in parallel—one reading docs, one analyzing your repo's history, one finding community patterns. In 60 seconds, you have a plan built on institutional memory instead of starting cold. + You know that moment when you open a ticket and think "how did we solve this last time?" The framework-docs-researcher already knows. The git-history-analyzer remembers what worked in March. Run /plan and three research agents work in parallel—one reading docs, one analyzing your repo's history, one finding community patterns. In 60 seconds, you have a plan built on institutional memory instead of starting cold.

framework-docs-researcher @@ -144,11 +241,11 @@

Delegate

Work with experts who never forget

- The security-sentinel has checked 10,000 PRs for SQL injection. The kieran-rails-reviewer never approves a controller with business logic. They don't get tired, don't skip Friday afternoon reviews, don't forget the conventions you agreed on in March. Run /workflows:work and watch your plan execute with quality gates that actually enforce your standards—every single time. + The security-sentinel has checked 10,000 PRs for SQL injection. The kieran-rails-reviewer never approves a controller with business logic. They don't get tired, don't skip Friday afternoon reviews, don't forget the conventions you agreed on in March. Run /work and watch your plan execute with quality gates that actually enforce your standards—every single time.

23 specialized agents - /workflows:work + /work dhh-ruby-style skill git-worktree skill
@@ -161,7 +258,7 @@

Assess

Get twelve opinions without twelve meetings

- Type /workflows:review PR#123 and go get coffee. When you come back, you'll have a security audit (did you sanitize that user input?), performance analysis (N+1 spotted on line 47), architecture review (this breaks the pattern from v2.3), data integrity check (that migration will fail in production), and eight more specialized reviews. All running in parallel. All categorized by severity. All stored as actionable P1/P2/P3 todos you can knock out in order. + Type /review PR#123 and go get coffee. When you come back, you'll have a security audit (did you sanitize that user input?), performance analysis (N+1 spotted on line 47), architecture review (this breaks the pattern from v2.3), data integrity check (that migration will fail in production), and eight more specialized reviews. All running in parallel. All categorized by severity. All stored as actionable P1/P2/P3 todos you can knock out in order.

security-sentinel @@ -178,10 +275,10 @@

Codify

Make sure you never solve the same bug twice

- Remember that CORS issue you debugged for three hours last month? Neither do I. That's the problem. Run /workflows:codify right after you fix something and it captures the solution as searchable documentation with YAML frontmatter. Next time someone hits the same issue, they grep for "CORS production" and find your answer in five seconds instead of re-debugging for three hours. That's how you compound. + Remember that CORS issue you debugged for three hours last month? Neither do I. That's the problem. Run /codify right after you fix something and it captures the solution as searchable documentation with YAML frontmatter. Next time someone hits the same issue, they grep for "CORS production" and find your answer in five seconds instead of re-debugging for three hours. That's how you compound.

- /workflows:codify + /codify codify-docs skill file-todos skill
@@ -429,7 +526,7 @@ 18 Powerful Commands

- Slash commands that replace entire workflows. /workflows:review is your code review committee. /workflows:plan is your research team. /triage sorts 50 todos in the time it takes you to read five. Each one automates hours of work into a single line. + Slash commands that replace entire workflows. /review is your code review committee. /plan is your research team. /triage sorts 50 todos in the time it takes you to read five. Each one automates hours of work into a single line.

@@ -439,28 +536,28 @@
- /workflows:plan + /plan core

Create comprehensive implementation plans with research agents and stakeholder analysis.

- /workflows:review + /review core

Run exhaustive code reviews using 12 or more parallel agents, ultra-thinking, and worktrees.

- /workflows:work + /work core

Execute work items systematically with progress tracking and validation.

- /workflows:codify + /codify core

Document solved problems for the knowledge base. Turn learnings into reusable patterns.

@@ -798,7 +895,7 @@

Ship Faster

# Run a 12-agent code review
-/workflows:review PR#123
+/review PR#123
 
 # Get a security audit
 claude agent security-sentinel
diff --git a/docs/pages/changelog.html b/docs/pages/changelog.html
index b102d63..f4ef705 100644
--- a/docs/pages/changelog.html
+++ b/docs/pages/changelog.html
@@ -323,7 +323,7 @@
               
  • /prime - Prime/setup command
  • /create-agent-skill - Create or edit Claude Code skills
  • /heal-skill - Fix skill documentation issues
  • -
  • /workflows:codify - Document solved problems for knowledge base
  • +
  • /codify - Document solved problems for knowledge base
  • New Skills (10)

    diff --git a/docs/pages/commands.html b/docs/pages/commands.html index 5eaf6c9..069a34b 100644 --- a/docs/pages/commands.html +++ b/docs/pages/commands.html @@ -72,7 +72,7 @@

    Command Reference

    - Here's the thing about slash commands: they're workflows you'd spend 20 minutes doing manually, compressed into one line. Type /workflows:plan and watch three agents launch in parallel to research your codebase while you grab coffee. That's the point—automation that actually saves time, not busywork dressed up as productivity. + Here's the thing about slash commands: they're workflows you'd spend 20 minutes doing manually, compressed into one line. Type /plan and watch three agents launch in parallel to research your codebase while you grab coffee. That's the point—automation that actually saves time, not busywork dressed up as productivity.

    @@ -82,7 +82,7 @@
    - /workflows:plan + /plan

    You've got a feature request and a blank page. This command turns "we need OAuth" into a structured plan that actually tells you what to build—researched, reviewed, and ready to execute. @@ -116,14 +116,14 @@

    -
    /workflows:plan Add OAuth integration for third-party auth
    -/workflows:plan Fix N+1 query in user dashboard
    +
    /plan Add OAuth integration for third-party auth
    +/plan Fix N+1 query in user dashboard
    - /workflows:review + /review

    Twelve specialized reviewers examine your PR in parallel—security, performance, architecture, patterns. It's like code review by committee, except the committee finishes in two minutes instead of two days. @@ -154,16 +154,16 @@

    -
    /workflows:review 42
    -/workflows:review https://github.com/owner/repo/pull/42
    -/workflows:review feature-branch-name
    -/workflows:review latest
    +
    /review 42
    +/review https://github.com/owner/repo/pull/42
    +/review feature-branch-name
    +/review latest
    - /workflows:work + /work

    Point this at a plan file and watch it execute—reading requirements, setting up environment, running tests, creating commits, opening PRs. It's the "just build the thing" button you wish you always had. @@ -203,14 +203,14 @@

    -
    /workflows:work plans/user-authentication.md
    -/workflows:work todos/042-ready-p1-performance-issue.md
    +
    /work plans/user-authentication.md
    +/work todos/042-ready-p1-performance-issue.md
    - /workflows:codify + /codify

    Just fixed a gnarly bug? This captures the solution before you forget it. Seven agents analyze what you did, why it worked, and how to prevent it next time. Your future self will thank you. @@ -236,8 +236,8 @@

    Auto-Triggers

    Phrases: "that worked", "it's fixed", "working now", "problem solved"

    -
    /workflows:codify
    -/workflows:codify N+1 query optimization
    +
    /codify
    +/codify N+1 query optimization
    diff --git a/docs/pages/getting-started.html b/docs/pages/getting-started.html index c4592cb..721fe64 100644 --- a/docs/pages/getting-started.html +++ b/docs/pages/getting-started.html @@ -131,16 +131,16 @@

    Let's see what this thing can actually do. I'll show you three workflows you'll use constantly:

    Run a Code Review

    -

    This is the big one. Type /workflows:review and watch it spawn 10+ specialized reviewers:

    +

    This is the big one. Type /review and watch it spawn 10+ specialized reviewers:

    # Review a PR by number
    -/workflows:review 123
    +/review 123
     
     # Review the current branch
    -/workflows:review
    +/review
     
     # Review a specific branch
    -/workflows:review feature/my-feature
    +/review feature/my-feature

    Use a Specialized Agent

    @@ -331,11 +331,11 @@ claude agent git-history-analyzer "Show changes to user model"

    Running Commands

    -
    # Workflow commands (prefix: /workflows:)
    -/workflows:plan
    -/workflows:review 123
    -/workflows:work
    -/workflows:codify
    +            
    # Workflow commands
    +/plan
    +/review 123
    +/work
    +/codify
     
     # Utility commands
     /changelog
    @@ -344,7 +344,7 @@ claude agent git-history-analyzer "Show changes to user model"

    The Review Workflow

    -

    Let me show you what happens when you run /workflows:review. Here's the sequence:

    +

    Let me show you what happens when you run /review. Here's the sequence:

    1. Detection - Figures out what you want reviewed (PR number, branch name, or current changes)
    2. Isolation - Spins up a git worktree so the review doesn't mess with your working directory
    3. @@ -406,10 +406,10 @@ skill: gemini-imagegen

      Basic Review

      # Review a PR
      -/workflows:review 123
      +/review 123
       
       # Review current branch
      -/workflows:review
      +/review

      Understanding Findings

      diff --git a/docs/pages/skills.html b/docs/pages/skills.html index c98130a..1fe4177 100644 --- a/docs/pages/skills.html +++ b/docs/pages/skills.html @@ -435,8 +435,8 @@ bash scripts/worktree-manager.sh cleanup

    Integration

      -
    • Works with /workflows:review for isolated PR analysis
    • -
    • Works with /workflows:work for parallel feature development
    • +
    • Works with /review for isolated PR analysis
    • +
    • Works with /work for parallel feature development

    Requirements

      diff --git a/plans/landing-page-launchkit-refresh.md b/plans/landing-page-launchkit-refresh.md index 3ba4357..8384ee2 100644 --- a/plans/landing-page-launchkit-refresh.md +++ b/plans/landing-page-launchkit-refresh.md @@ -41,7 +41,7 @@ Review and enhance the `/docs/index.html` landing page using LaunchKit elements **Potential Improvements:** - Add `→` arrow to "Install Plugin" button -- Consider adding animated terminal GIF below buttons showing `/workflows:review` in action +- Consider adding animated terminal GIF below buttons showing `/review` in action ### 2. Stats Section (lines 81-104) diff --git a/plugins/compounding-engineering/CHANGELOG.md b/plugins/compounding-engineering/CHANGELOG.md index b2f2885..bb9afec 100644 --- a/plugins/compounding-engineering/CHANGELOG.md +++ b/plugins/compounding-engineering/CHANGELOG.md @@ -100,7 +100,7 @@ Major reorganization consolidating agents, commands, and skills from multiple so - `/prime` - Prime/setup command - `/create-agent-skill` - Create or edit Claude Code skills - `/heal-skill` - Fix skill documentation issues -- `/workflows:codify` - Document solved problems for knowledge base +- `/codify` - Document solved problems for knowledge base **New Skills (10)** - `andrew-kane-gem-writer` - Write Ruby gems following Andrew Kane's patterns @@ -125,7 +125,7 @@ Major reorganization consolidating agents, commands, and skills from multiple so **Commands Restructured** - Workflow commands moved to `commands/workflows/` subdirectory -- `/plan`, `/review`, `/work` now accessed as `/workflows:plan`, `/workflows:review`, `/workflows:work` +- `/plan`, `/review`, `/work`, `/codify` accessible via short names (autocomplete) or full path ### Summary diff --git a/plugins/compounding-engineering/CLAUDE.md b/plugins/compounding-engineering/CLAUDE.md index f0a24c1..7fc46f1 100644 --- a/plugins/compounding-engineering/CLAUDE.md +++ b/plugins/compounding-engineering/CLAUDE.md @@ -35,7 +35,7 @@ agents/ └── docs/ # Documentation agents commands/ -├── workflows/ # Core workflow commands (/workflows:*) +├── workflows/ # Core workflow commands (/plan, /review, /work, /codify) └── *.md # Utility commands skills/ diff --git a/plugins/compounding-engineering/README.md b/plugins/compounding-engineering/README.md index d53b110..1515e61 100644 --- a/plugins/compounding-engineering/README.md +++ b/plugins/compounding-engineering/README.md @@ -67,14 +67,14 @@ Agents are organized into categories for easier discovery. ### Workflow Commands -Access via `/workflows:command`: +Core workflow commands (use the short form for autocomplete): | Command | Description | |---------|-------------| -| `/workflows:plan` | Create implementation plans | -| `/workflows:review` | Run comprehensive code reviews | -| `/workflows:work` | Execute work items systematically | -| `/workflows:codify` | Document solved problems for knowledge base | +| `/plan` | Create implementation plans | +| `/review` | Run comprehensive code reviews | +| `/work` | Execute work items systematically | +| `/codify` | Document solved problems for knowledge base | ### Utility Commands diff --git a/plugins/compounding-engineering/commands/generate_command.md b/plugins/compounding-engineering/commands/generate_command.md index fc7aa7a..53a15d3 100644 --- a/plugins/compounding-engineering/commands/generate_command.md +++ b/plugins/compounding-engineering/commands/generate_command.md @@ -127,7 +127,7 @@ Implement #$ARGUMENTS following these steps: ## Creating the Command File -1. **Create the file** at `.claude/commands/[name].md` or `.claude/commands/workflows/[name].md` +1. **Create the file** at `.claude/commands/[name].md` (subdirectories like `workflows/` supported) 2. **Start with YAML frontmatter** (see section above) 3. **Structure the command** using the template above 4. **Test the command** by using it with appropriate arguments diff --git a/plugins/compounding-engineering/skills/file-todos/SKILL.md b/plugins/compounding-engineering/skills/file-todos/SKILL.md index a9439c5..66ff991 100644 --- a/plugins/compounding-engineering/skills/file-todos/SKILL.md +++ b/plugins/compounding-engineering/skills/file-todos/SKILL.md @@ -184,7 +184,7 @@ Work logs serve as: | Trigger | Flow | Tool | |---------|------|------| -| Code review | `/workflows:review` → Findings → `/triage` → Todos | Review agent + skill | +| Code review | `/review` → Findings → `/triage` → Todos | Review agent + skill | | PR comments | `/resolve_pr_parallel` → Individual fixes → Todos | gh CLI + skill | | Code TODOs | `/resolve_todo_parallel` → Fixes + Complex todos | Agent + skill | | Planning | Brainstorm → Create todo → Work → Complete | Skill | diff --git a/plugins/compounding-engineering/skills/git-worktree/SKILL.md b/plugins/compounding-engineering/skills/git-worktree/SKILL.md index cbf7ae7..71a1dae 100644 --- a/plugins/compounding-engineering/skills/git-worktree/SKILL.md +++ b/plugins/compounding-engineering/skills/git-worktree/SKILL.md @@ -20,8 +20,8 @@ This skill provides a unified interface for managing Git worktrees across your d Use this skill in these scenarios: -1. **Code Review (`/workflows:review`)**: If NOT already on the PR branch, offer worktree for isolated review -2. **Feature Work (`/workflows:work`)**: Always ask if user wants parallel worktree or live branch work +1. **Code Review (`/review`)**: If NOT already on the PR branch, offer worktree for isolated review +2. **Feature Work (`/work`)**: Always ask if user wants parallel worktree or live branch work 3. **Parallel Development**: When working on multiple features simultaneously 4. **Cleanup**: After completing work in a worktree @@ -29,7 +29,7 @@ Use this skill in these scenarios: ### In Claude Code Workflows -The skill is automatically called from `/workflows:review` and `/workflows:work` commands: +The skill is automatically called from `/review` and `/work` commands: ``` # For review: offers worktree if not on PR branch @@ -182,7 +182,7 @@ bash .claude/skills/git-worktree/scripts/worktree-manager.sh cleanup ## Integration with Workflows -### `/workflows:review` +### `/review` Instead of always creating a worktree: @@ -195,7 +195,7 @@ Instead of always creating a worktree: - no → proceed with PR diff on current branch ``` -### `/workflows:work` +### `/work` Always offer choice: