You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CLAUDE.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,12 +117,12 @@ wt <command> --help-page
117
117
```
118
118
119
119
The generated content includes:
120
-
1.**Conceptual documentation** — from `after_long_help` in `src/cli.rs`
120
+
1.**Conceptual documentation** — from `after_long_help` in `src/cli/mod.rs`
121
121
2.**Command Reference section** — the standard `--help` output
122
122
123
123
### Editing command docs
124
124
125
-
**To update command documentation, edit `src/cli.rs`**, not the markdown files directly.
125
+
**To update command documentation, edit `src/cli/mod.rs`**, not the markdown files directly.
126
126
127
127
-**Conceptual content** — Edit the `after_long_help` attribute on the command
128
128
-**Usage/options/examples** — Edit the clap attributes (`about`, `long_about`, doc comments on args)
@@ -135,7 +135,7 @@ cargo test --test integration test_docs_are_in_sync
135
135
136
136
### Command documentation structure
137
137
138
-
Each command has three documentation pieces in `src/cli.rs`:
138
+
Each command has three documentation pieces in `src/cli/mod.rs`:
139
139
140
140
| Piece | Source | Purpose |
141
141
|-------|--------|---------|
@@ -179,7 +179,7 @@ Each command has three documentation pieces in `src/cli.rs`:
179
179
180
180
### Example output expansion (wt list)
181
181
182
-
The `wt list` examples use **HTML comments + code blocks** that expand to full snapshot output. In `cli.rs`, you write:
182
+
The `wt list` examples use **HTML comments + code blocks** that expand to full snapshot output. In `src/cli/mod.rs`, you write:
183
183
184
184
`````
185
185
<!-- wt list -->
@@ -218,7 +218,7 @@ This renders differently in each context:
218
218
3. Accept snapshots: `cargo insta accept`
219
219
4. Sync docs: `cargo test --test integration test_docs_are_in_sync`
220
220
221
-
The examples in `cli.rs` are just command stubs — the actual output comes from snapshots generated by integration tests. This ensures docs always match real CLI behavior.
221
+
The examples in `src/cli/mod.rs` are just command stubs — the actual output comes from snapshots generated by integration tests. This ensures docs always match real CLI behavior.
222
222
223
223
### Code block convention
224
224
@@ -246,7 +246,7 @@ Content in `after_long_help` must work in **both** the terminal (`--help`) and t
246
246
247
247
### Post-processing for web docs
248
248
249
-
The `--help-page` generator in `src/main.rs` applies post-processing to transform CLI-friendly content into web-friendly HTML:
249
+
The `--help-page` generator in `src/help.rs` applies post-processing to transform CLI-friendly content into web-friendly HTML:
250
250
251
251
| CLI Source | Web Output |
252
252
|------------|------------|
@@ -271,7 +271,7 @@ Include subcommand documentation as H2 sections within a parent command's docs p
271
271
<!-- subdoc: subcommand-name -->
272
272
```
273
273
274
-
In `cli.rs`, add the placeholder anywhere in the parent command's `after_long_help`:
274
+
In `src/cli/mod.rs`, add the placeholder anywhere in the parent command's `after_long_help`:
0 commit comments