Skip to content

Commit 058904e

Browse files
committed
Tweak getting started docs
1 parent 81e1aec commit 058904e

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

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

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ cd /path/to/your-repo
2727
codebuff
2828
```
2929

30-
Codebuff has multiple [modes](/docs/tips/modes): `lite` for quick tasks, `max` for complex work, and `plan` for planning without file changes. You can invoke them in the slash menu with `/mode:`.
30+
Codebuff has multiple [modes](/docs/tips/modes): `plan` for planning without file changes, `max` for better results at higher cost and time. You can invoke them in the slash menu with `/mode`.
3131

3232
## 4. Initialize Your Project (Optional)
3333

@@ -39,18 +39,13 @@ Run the `/init` command inside Codebuff to set up project-specific files:
3939

4040
### What `/init` Creates
4141

42-
| File/Directory | Purpose |
43-
|---------------|----------|
44-
| `knowledge.md` | A starter file for documenting your project's setup commands, architecture, and coding conventions. Codebuff reads this to understand your project better. |
45-
| `.agents/types/` | TypeScript type definitions for creating custom agents. |
42+
- `knowledge.md` — A starter file for documenting your project's setup commands, architecture, and coding conventions. Codebuff reads this to understand your project better.
43+
- `.agents/types/` — TypeScript type definitions for creating custom agents.
4644

4745
### When to Use `/init`
4846

49-
- **New projects** — Run `/init` once to create a `knowledge.md` file and get Codebuff familiar with your project.
50-
- **Building custom agents** — The `.agents/types/` directory provides TypeScript types for full IntelliSense when creating agents.
51-
- **Team onboarding** — Commit `knowledge.md` to your repo so Codebuff works consistently for all team members.
52-
53-
> **Note:** `/init` is safe to run multiple times. It skips files that already exist and only creates missing ones.
47+
- **New projects** — if you don't already have an AGENTS.md or CLAUDE.md (Codebuff will also read these files).
48+
- **Building custom agents** — running /init is the first step to [creating your own agents](/docs/walkthroughs/creating-your-first-agent)!
5449

5550
## Troubleshooting
5651

0 commit comments

Comments
 (0)