Skip to content

Commit 4b68050

Browse files
fix(docs): sync command names with install script (#55)
Fixes #54 The install script installs commands as {category}-{name} (e.g. development-scaffold) but GETTING-STARTED.md referenced them as short names (/scaffold, /review, etc.). Updated all command references: - /scaffold → /development-scaffold - /review → /workflow-review - /test-gen → /testing-test-gen - /docs-gen → /documentation-docs-gen
1 parent 0070004 commit 4b68050

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

GETTING-STARTED.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ ls ~/.claude/commands/ # 4 commands
3737
claude "@code-reviewer Analyze this file"
3838

3939
# Test a command
40-
claude "/scaffold react-component Button"
40+
claude "/development-scaffold react-component Button"
4141
```
4242

4343
**✅ You're ready!** Skills are available and Claude will invoke them during conversations when relevant.
@@ -89,7 +89,7 @@ claude "@code-reviewer --focus security"
8989
git add .
9090

9191
# 3. Run comprehensive review
92-
claude "/review --scope staged --checks all"
92+
claude "/workflow-review --scope staged --checks all"
9393

9494
# This coordinates:
9595
# - @code-reviewer: Code quality and patterns
@@ -113,9 +113,9 @@ claude "/review --scope staged --checks all"
113113
./scripts/install.sh --commands
114114

115115
# 2. Scaffold components/projects
116-
claude "/scaffold react-component UserProfile --hooks --tests"
117-
claude "/scaffold express-api user-service --auth --database"
118-
claude "/scaffold nextjs-app my-app --typescript --tailwind"
116+
claude "/development-scaffold react-component UserProfile --hooks --tests"
117+
claude "/development-scaffold express-api user-service --auth --database"
118+
claude "/development-scaffold nextjs-app my-app --typescript --tailwind"
119119

120120
# 3. Generated structure:
121121
# - Component files with boilerplate
@@ -142,7 +142,7 @@ claude "/scaffold nextjs-app my-app --typescript --tailwind"
142142
# Claude invokes test-generator skill when relevant
143143

144144
# 3. Generate comprehensive test suites
145-
claude "/test-gen --file src/utils/api.ts --framework jest --coverage 90"
145+
claude "/testing-test-gen --file src/utils/api.ts --framework jest --coverage 90"
146146

147147
# 4. For complex testing needs
148148
claude "@test-engineer Create comprehensive test suite with edge cases"
@@ -182,7 +182,7 @@ function createUser(req, res) { /* code */ }
182182
# ✅ Documentation updates
183183

184184
# 3. For comprehensive docs
185-
claude "/docs-gen api --format openapi"
185+
claude "/documentation-docs-gen api --format openapi"
186186
claude "@docs-writer Create user guide with examples"
187187

188188
# Result: Well-documented APIs
@@ -212,13 +212,13 @@ claude
212212

213213
# 3. Run formal review when ready
214214
git add src/auth/
215-
claude "/review --scope staged"
215+
claude "/workflow-review --scope staged"
216216

217217
# 4. Generate comprehensive tests
218-
claude "/test-gen --file src/auth/login.ts --framework jest"
218+
claude "/testing-test-gen --file src/auth/login.ts --framework jest"
219219

220220
# 5. Update documentation
221-
claude "/docs-gen --update-readme"
221+
claude "/documentation-docs-gen --update-readme"
222222

223223
# 6. Commit
224224
git commit -m "feat(auth): add login with OAuth2"
@@ -264,7 +264,7 @@ git commit -m "fix(api): resolve memory leak in WebSocket"
264264
gh pr checkout 123
265265
266266
# 2. Comprehensive review
267-
claude "/review --scope pr --checks all"
267+
claude "/workflow-review --scope pr --checks all"
268268
269269
# Review covers:
270270
# ✅ Code quality (patterns, smells)
@@ -300,7 +300,7 @@ claude "/review --scope pr --checks all"
300300
### Commands (Tier 3: Workflows)
301301
- **What:** Multi-agent orchestrated workflows
302302
- **When:** You run a command (`/command`)
303-
- **Examples:** /review, /scaffold, /test-gen
303+
- **Examples:** /workflow-review, /development-scaffold, /testing-test-gen
304304
305305
**Think of commands like:** Running a script - automates complex multi-step processes
306306
@@ -359,13 +359,13 @@ See [skills/TEMPLATES.md](skills/TEMPLATES.md) for copy-paste templates
359359
- ✅ Request deep analysis: `@code-reviewer Analyze this`
360360
361361
### Day 2: Commands
362-
- ✅ Try scaffolding: `/scaffold react-component TestComponent`
363-
- ✅ Run code review: `/review --scope staged`
364-
- ✅ Generate tests: `/test-gen --file utils.js`
362+
- ✅ Try scaffolding: `/development-scaffold react-component TestComponent`
363+
- ✅ Run code review: `/workflow-review --scope staged`
364+
- ✅ Generate tests: `/testing-test-gen --file utils.js`
365365
366366
### Week 1: Integration
367367
- ✅ Use skills + sub-agents together during conversations
368-
- ✅ Integrate `/review` into PR workflow
368+
- ✅ Integrate `/workflow-review` into PR workflow
369369
- ✅ Discuss documentation updates with Claude (skills suggest improvements)
370370
371371
### Week 2: Customization

0 commit comments

Comments
 (0)