Skip to content

Commit 1269b1f

Browse files
committed
docs: fix plan mode docs (slash command not flag), fix modes page links, update best-practices
1 parent 5fb266e commit 1269b1f

File tree

4 files changed

+15
-17
lines changed

4 files changed

+15
-17
lines changed

web/src/content/help/quick-start.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ cd /path/to/your-repo
2929
codebuff
3030
```
3131

32-
Codebuff has multiple [modes](/docs/help#modes): `--lite` for quick tasks, `--max` for complex work, and `--plan` for planning without file changes.
32+
Codebuff has multiple [modes](/docs/tips#modes): `--lite` for quick tasks, `--max` for complex work, and `/mode:plan` for planning without file changes.
3333

3434
## Troubleshooting
3535

web/src/content/tips/best-practices.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Codebuff skips files in `.gitignore`. For files you keep in git but want Codebuf
1919

2020
## Planning
2121

22-
Use `--plan` mode to scope work before implementing. Codebuff gathers context, asks clarifying questions, and outputs a structured plan without touching files. Review and adjust the plan, then switch to default or max mode to execute.
22+
Use `/mode:plan` to scope work before implementing. Codebuff gathers context, asks clarifying questions, and outputs a structured plan without touching files. Review and adjust the plan, then switch to default or max mode to execute.
2323

24-
See [Modes](/docs/help#modes) for details on plan mode and other options.
24+
See [Modes](/docs/tips#modes) for details on plan mode and other options.
2525

2626
## Include docs by link
2727

web/src/content/tips/keyboard-shortcuts.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,8 @@ Commands inside Codebuff:
2222
- `--help`: list options
2323
- `--lite`: faster, cheaper responses
2424
- `--max`: more context for hard work
25-
- `--plan`: plan only, no file changes
2625

27-
See [Modes](/docs/help#modes) for details on each mode.
26+
See [Modes](/docs/tips#modes) for details on each mode. Plan mode is available via `/mode:plan` during a session.
2827

2928
## Terminal commands
3029

web/src/content/tips/modes.mdx

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ order: 2
77

88
# Modes
99

10-
Codebuff has four modes. Switch with flags or cycle using `Ctrl+M` in the CLI.
10+
Codebuff has four modes. Start with `--lite` or `--max` flags, or switch during a session with `Ctrl+M` or `/mode:` commands.
1111

1212
## Default
1313

@@ -54,9 +54,9 @@ Best for complex features and refactors.
5454
codebuff --max
5555
```
5656

57-
## Plan (`--plan`)
57+
## Plan (`/mode:plan`)
5858

59-
Planning mode. No file writes.
59+
Planning mode. No file writes. Only available via slash command during a session.
6060

6161
- Gathers context about your codebase
6262
- Asks clarifying questions using `ask_user`
@@ -65,19 +65,19 @@ Planning mode. No file writes.
6565

6666
Use this to scope out work before implementing, or to discuss approaches without making changes.
6767

68-
```bash
69-
codebuff --plan
68+
```
69+
/mode:plan
7070
```
7171

7272
## Mode Comparison
7373

7474
<MarkdownTable>
75-
| Mode | Model | Editor Agent | Code Review | Best For |
75+
| Mode | How to activate | Model | Editor Agent | Code Review |
7676
| --- | --- | --- | --- | --- |
77-
| Default | Claude Opus 4.5 | `editor` | Yes | Everyday coding |
78-
| Lite | Grok 4.1 Fast | `editor-gpt-5` | No | Quick tasks |
79-
| Max | Claude Opus 4.5 | `editor-multi-prompt` | Yes | Complex work |
80-
| Plan | Claude Opus 4.5 | None | No | Planning |
77+
| Default | `codebuff` | Claude Opus 4.5 | `editor` | Yes |
78+
| Lite | `codebuff --lite` | Grok 4.1 Fast | `editor-gpt-5` | No |
79+
| Max | `codebuff --max` | Claude Opus 4.5 | `editor-multi-prompt` | Yes |
80+
| Plan | `/mode:plan` | Claude Opus 4.5 | None | No |
8181
</MarkdownTable>
8282

8383
## Switching Modes
@@ -86,8 +86,7 @@ codebuff --plan
8686
```bash
8787
codebuff --lite
8888
codebuff --max
89-
codebuff --plan
9089
```
9190

9291
**During a session:**
93-
Press `Ctrl+M` to cycle through modes, or use the mode toggle in the input area.
92+
Press `Ctrl+M` to cycle through modes, or type `/mode:default`, `/mode:lite`, `/mode:max`, or `/mode:plan`.

0 commit comments

Comments
 (0)