Skip to content

Commit 3c04588

Browse files
docs: refresh stale path references in docs/CLAUDE.md (#2739)
1 parent 4cdab4e commit 3c04588

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

docs/CLAUDE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -117,12 +117,12 @@ wt <command> --help-page
117117
```
118118

119119
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`
121121
2. **Command Reference section** — the standard `--help` output
122122

123123
### Editing command docs
124124

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.
126126

127127
- **Conceptual content** — Edit the `after_long_help` attribute on the command
128128
- **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
135135

136136
### Command documentation structure
137137

138-
Each command has three documentation pieces in `src/cli.rs`:
138+
Each command has three documentation pieces in `src/cli/mod.rs`:
139139

140140
| Piece | Source | Purpose |
141141
|-------|--------|---------|
@@ -179,7 +179,7 @@ Each command has three documentation pieces in `src/cli.rs`:
179179

180180
### Example output expansion (wt list)
181181

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:
183183

184184
`````
185185
<!-- wt list -->
@@ -218,7 +218,7 @@ This renders differently in each context:
218218
3. Accept snapshots: `cargo insta accept`
219219
4. Sync docs: `cargo test --test integration test_docs_are_in_sync`
220220

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.
222222

223223
### Code block convention
224224

@@ -246,7 +246,7 @@ Content in `after_long_help` must work in **both** the terminal (`--help`) and t
246246

247247
### Post-processing for web docs
248248

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:
250250

251251
| CLI Source | Web Output |
252252
|------------|------------|
@@ -271,7 +271,7 @@ Include subcommand documentation as H2 sections within a parent command's docs p
271271
<!-- subdoc: subcommand-name -->
272272
```
273273

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`:
275275

276276
```rust
277277
after_long_help = r#"...main documentation...

0 commit comments

Comments
 (0)