Skip to content

Commit 6fdf5b3

Browse files
committed
docs: fix all outdated CLI command references
Updated all documentation to use the current simplified CLI commands after PR #53 removed the 'recipe' subcommand. Command Changes (Old → New): - `dot recipe create` → `dot create` - `dot recipe test` → `dot test` - `dot recipe submit` → `dot submit` Files Updated (10 files, ~80 replacements): - docs/getting-started/first-recipe.md - docs/developers/cli-reference.md (extensive updates) - docs/contributors/workflow.md - docs/contributors/troubleshooting.md - docs/contributors/README.md - docs/developers/README.md - docs/developers/architecture.md - dot/cli/README.md - install.sh (help text) - .github/workflows/test-sdk.yml (test commands) All documentation now correctly reflects the simplified CLI structure introduced in v0.5.0.
1 parent 84cfc8b commit 6fdf5b3

File tree

10 files changed

+64
-64
lines changed

10 files changed

+64
-64
lines changed

.github/workflows/test-sdk.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ jobs:
298298
- name: Test CLI - Valid recipe creation
299299
if: needs.check-changes.outputs.sdk_changed == 'true'
300300
run: |
301-
cargo run --package cli --locked -- recipe create --title "Testing CLI Validation" --skip-install --no-git --non-interactive
301+
cargo run --package cli --locked -- create --title "Testing CLI Validation" --skip-install --no-git --non-interactive
302302
if [ ! -f "recipes/testing-cli-validation/README.md" ]; then
303303
echo "Error: Project was not created"
304304
exit 1
@@ -308,7 +308,7 @@ jobs:
308308
- name: Test CLI - Missing required title
309309
if: needs.check-changes.outputs.sdk_changed == 'true'
310310
run: |
311-
if cargo run --package cli --locked -- recipe create --non-interactive 2>&1 | grep -q "Title argument"; then
311+
if cargo run --package cli --locked -- create --non-interactive 2>&1 | grep -q "Title argument"; then
312312
echo "✓ Missing title error message found"
313313
exit 0
314314
else

docs/contributors/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ If you're new to contributing, follow this path:
2626
1. **Install the CLI** - See [Getting Started](../getting-started/installation.md)
2727
2. **Read the Workflow** - Understand the [contribution workflow](workflow.md)
2828
3. **Check Guidelines** - Review [recipe guidelines](recipe-guidelines.md)
29-
4. **Create a Recipe** - Use `dot recipe create`
29+
4. **Create a Recipe** - Use `dot create`
3030
5. **Follow Standards** - Use [conventional commits](commit-conventions.md)
3131
6. **Test Thoroughly** - Follow [testing guide](testing-recipes.md)
3232
7. **Submit PR** - Follow the [workflow guide](workflow.md)

docs/contributors/troubleshooting.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ sudo dnf install git
104104

105105
**Symptom:**
106106
```bash
107-
$ dot recipe submit
107+
$ dot submit
108108
Error: GitHub CLI not authenticated
109109
```
110110

@@ -133,7 +133,7 @@ gh auth status
133133

134134
**Symptom:**
135135
```bash
136-
$ dot recipe create
136+
$ dot create
137137
Error: Recipe directory already exists: recipes/my-recipe
138138
```
139139

@@ -143,12 +143,12 @@ Error: Recipe directory already exists: recipes/my-recipe
143143

144144
```bash
145145
# Option 1: Use different name
146-
dot recipe create
146+
dot create
147147
# Enter different title
148148

149149
# Option 2: Remove existing directory
150150
rm -rf recipes/my-recipe
151-
dot recipe create
151+
dot create
152152

153153
# Option 3: Continue working on existing recipe
154154
cd recipes/my-recipe
@@ -186,7 +186,7 @@ cd recipes/my-recipe
186186
npm install
187187

188188
# Use --skip-install flag
189-
dot recipe create --skip-install
189+
dot create --skip-install
190190
cd recipes/my-recipe
191191
npm install
192192
```
@@ -206,7 +206,7 @@ Recipe created but no git branch
206206
git init
207207

208208
# Or use --no-git flag
209-
dot recipe create --no-git
209+
dot create --no-git
210210
```
211211

212212
---
@@ -667,7 +667,7 @@ git push --force-with-lease
667667

668668
**Symptom:**
669669
```bash
670-
$ dot recipe submit
670+
$ dot submit
671671
Error: Failed to create pull request
672672
```
673673

docs/contributors/workflow.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The CLI automatically creates a new branch for your recipe:
8484

8585
```bash
8686
# Interactive mode
87-
dot recipe create
87+
dot create
8888

8989
# The CLI will:
9090
# 1. Create recipes/your-recipe/
@@ -305,7 +305,7 @@ git push -u origin recipe/your-recipe
305305

306306
**Option A: Using the CLI (Recommended)**
307307
```bash
308-
dot recipe submit
308+
dot submit
309309
```
310310

311311
The CLI will:
@@ -452,7 +452,7 @@ git checkout master
452452
git pull upstream master
453453

454454
# Create new recipe
455-
dot recipe create
455+
dot create
456456
```
457457

458458
---
@@ -594,7 +594,7 @@ cd polkadot-cookbook
594594
git remote add upstream https://github.com/polkadot-developers/polkadot-cookbook.git
595595

596596
# Create recipe
597-
dot recipe create
597+
dot create
598598

599599
# Test
600600
npm test # TypeScript
@@ -606,7 +606,7 @@ git commit -m "feat(recipe): description"
606606

607607
# Submit
608608
git push -u origin branch-name
609-
dot recipe submit
609+
dot submit
610610

611611
# Update fork
612612
git checkout master

docs/developers/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ The `dot` CLI provides commands for creating and managing recipes:
4848

4949
```bash
5050
# Create a new recipe
51-
dot recipe create --title "My Recipe"
51+
dot create --title "My Recipe"
5252

5353
# View versions
5454

5555
# Submit recipe for review
56-
dot recipe submit
56+
dot submit
5757
```
5858

5959
[→ Complete CLI Reference](cli-reference.md)

docs/developers/architecture.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ A thin CLI wrapper around the core library that provides a command-line interfac
6464

6565
### Commands
6666

67-
- `recipe create` - Create a new recipe with interactive prompts
68-
- `recipe test` - Test a recipe
69-
- `recipe submit` - Submit recipe as pull request
67+
- `create` - Create a new recipe with interactive prompts
68+
- `test` - Test a recipe
69+
- `submit` - Submit recipe as pull request
7070

7171
### Features
7272

@@ -82,16 +82,16 @@ A thin CLI wrapper around the core library that provides a command-line interfac
8282

8383
```bash
8484
# Create recipe - Interactive mode (prompts for options)
85-
dot recipe create
85+
dot create
8686

8787
# Non-interactive mode with title
88-
dot recipe create --title "My Recipe"
88+
dot create --title "My Recipe"
8989

9090
# With options
91-
dot recipe create --title "My Recipe" --skip-install --no-git --non-interactive
91+
dot create --title "My Recipe" --skip-install --no-git --non-interactive
9292

9393
# Non-interactive mode for CI/CD
94-
dot recipe create --title "My Recipe" --non-interactive
94+
dot create --title "My Recipe" --non-interactive
9595

9696
# View global dependency versions
9797

docs/developers/cli-reference.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ dot [GLOBAL_FLAGS] <COMMAND> [COMMAND_FLAGS]
1919

2020
## Commands
2121

22-
### `recipe create`
22+
### `create`
2323

2424
Create a new recipe with scaffolded structure.
2525

2626
**Usage:**
2727
```bash
28-
dot recipe create [OPTIONS]
28+
dot create [OPTIONS]
2929
```
3030

3131
**Interactive Mode (Recommended):**
3232
```bash
33-
dot recipe create
33+
dot create
3434
```
3535

3636
Launches an interactive prompt that guides you through:
@@ -39,7 +39,7 @@ Launches an interactive prompt that guides you through:
3939

4040
**Non-Interactive Mode:**
4141
```bash
42-
dot recipe create --title "My Recipe" --non-interactive [OPTIONS]
42+
dot create --title "My Recipe" --non-interactive [OPTIONS]
4343
```
4444

4545
**Options:**
@@ -64,22 +64,22 @@ dot recipe create --title "My Recipe" --non-interactive [OPTIONS]
6464

6565
```bash
6666
# Interactive mode (recommended)
67-
dot recipe create
67+
dot create
6868

6969
# Non-interactive parachain recipe
70-
dot recipe create --title "My Parachain" --pathway parachain --non-interactive
70+
dot create --title "My Parachain" --pathway parachain --non-interactive
7171

7272
# Pallet-only mode (advanced, no runtime)
73-
dot recipe create --title "My Pallet" --pathway parachain --pallet-only --non-interactive
73+
dot create --title "My Pallet" --pathway parachain --pallet-only --non-interactive
7474

7575
# Smart contracts recipe
76-
dot recipe create --title "My Contract" --pathway contracts --non-interactive
76+
dot create --title "My Contract" --pathway contracts --non-interactive
7777

7878
# Skip npm install for faster creation
79-
dot recipe create --title "Quick Test" --pathway basic-interaction --skip-install --non-interactive
79+
dot create --title "Quick Test" --pathway basic-interaction --skip-install --non-interactive
8080

8181
# CI/CD mode (skip git branch creation)
82-
dot recipe create \
82+
dot create \
8383
--title "My Recipe" \
8484
--pathway parachain \
8585
--skip-install \
@@ -133,13 +133,13 @@ Note: Structure varies by recipe pathway. See pathway-specific READMEs for detai
133133

134134
---
135135

136-
### `recipe submit`
136+
### `submit`
137137

138138
Submit recipe as a pull request (requires GitHub CLI).
139139

140140
**Usage:**
141141
```bash
142-
dot recipe submit
142+
dot submit
143143
```
144144

145145
**Prerequisites:**
@@ -180,13 +180,13 @@ git config --global user.email "your.email@example.com"
180180

181181
---
182182

183-
### `recipe test`
183+
### `test`
184184

185185
Run tests for a recipe.
186186

187187
**Usage:**
188188
```bash
189-
dot recipe test <SLUG>
189+
dot test <SLUG>
190190
```
191191

192192
**Arguments:**
@@ -200,10 +200,10 @@ dot recipe test <SLUG>
200200
**Examples:**
201201
```bash
202202
# Test specific recipe
203-
dot recipe test basic-pallet
203+
dot test basic-pallet
204204

205205
# Test current directory recipe
206-
dot recipe test .
206+
dot test .
207207
```
208208

209209
**Exit Codes:**
@@ -226,10 +226,10 @@ The CLI respects these environment variables:
226226

227227
```bash
228228
# Enable debug logging
229-
RUST_LOG=debug dot recipe create
229+
RUST_LOG=debug dot create
230230

231231
# Use specific GitHub token
232-
GITHUB_TOKEN=ghp_xxx dot recipe submit
232+
GITHUB_TOKEN=ghp_xxx dot submit
233233

234234
# Disable colors
235235
```
@@ -286,7 +286,7 @@ chmod +x target/release/dot
286286

287287
### GitHub Authentication Failed
288288

289-
**Symptom:** `dot recipe submit` fails with auth error
289+
**Symptom:** `dot submit` fails with auth error
290290

291291
**Solution:**
292292
```bash

docs/getting-started/first-recipe.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The CLI provides an interactive mode that guides you through recipe creation.
4141
### Run the Create Command
4242

4343
```bash
44-
dot recipe create
44+
dot create
4545
```
4646

4747
### Interactive Prompts
@@ -424,7 +424,7 @@ feat(recipe): <description>
424424
Once your recipe is complete and tested, submit it for review:
425425

426426
```bash
427-
dot recipe submit my-first-parachain
427+
dot submit my-first-parachain
428428
```
429429

430430
### What the Submit Command Does
@@ -488,7 +488,7 @@ The PR will automatically update with your changes.
488488
### Smart Contract (Solidity)
489489

490490
```bash
491-
dot recipe create
491+
dot create
492492
# Select: Smart Contract (Solidity)
493493
# Title: My First Contract
494494
```
@@ -515,7 +515,7 @@ npm test # Run tests
515515
### Basic Interaction (PAPI)
516516

517517
```bash
518-
dot recipe create
518+
dot create
519519
# Select: Basic Interaction
520520
# Title: Query Chain State
521521
```
@@ -543,7 +543,7 @@ npm test
543543
For advanced users building just a pallet (no runtime):
544544

545545
```bash
546-
dot recipe create --title "My Pallet" --pathway parachain --pallet-only --non-interactive
546+
dot create --title "My Pallet" --pathway parachain --pallet-only --non-interactive
547547
```
548548

549549
**Generated structure:**
@@ -599,7 +599,7 @@ Congratulations! You've created your first recipe. Here's what to explore next:
599599

600600
### Recipe Creation Failed
601601

602-
**Symptom:** `dot recipe create` fails with error
602+
**Symptom:** `dot create` fails with error
603603

604604
**Common causes:**
605605
- Git not configured
@@ -665,7 +665,7 @@ npm test
665665

666666
### GitHub Authentication Failed
667667

668-
**Symptom:** `dot recipe submit` fails with auth error
668+
**Symptom:** `dot submit` fails with auth error
669669

670670
**Solution:**
671671
```bash
@@ -684,7 +684,7 @@ gh auth token
684684
## Summary
685685

686686
You've learned how to:
687-
- ✅ Create a recipe with `dot recipe create`
687+
- ✅ Create a recipe with `dot create`
688688
- ✅ Understand the generated file structure
689689
- ✅ Build and test a parachain
690690
- ✅ Run PAPI integration tests

0 commit comments

Comments
 (0)