Skip to content

Commit 4434c8c

Browse files
committed
docs: update models page, add AGENTS.md/CLAUDE.md support, move modes to getting started, standardize discord links
1 parent fc0a257 commit 4434c8c

File tree

9 files changed

+41
-17
lines changed

9 files changed

+41
-17
lines changed

web/src/components/footer.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ const communityLinks: LinkInfo[] = [
3030
href: 'https://github.com/CodebuffAI/codebuff',
3131
target: '_blank',
3232
},
33-
{ text: 'Discord', href: 'https://discord.gg/mcWTGjgTj3', target: '_blank' },
33+
{ text: 'Discord', href: 'https://codebuff.com/discord', target: '_blank' },
3434
]
3535

3636
const authLinks: LinkInfo[] = [{ text: 'Login', href: '/login' }]

web/src/content/advanced/config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ If your startup processes aren't working as expected:
7272
3. Check the process output in the specified log files if you've configured them
7373
4. Make sure the JSON syntax in your configuration file is valid
7474

75-
Need more help? Check [Troubleshooting](/docs/advanced#troubleshooting) or join [Discord](https://discord.gg/mcWTGjgTj3).
75+
Need more help? Check [Troubleshooting](/docs/advanced#troubleshooting) or join [Discord](https://codebuff.com/discord).

web/src/content/advanced/what-models.mdx

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,32 @@ order: 3
77

88
# What models do you use?
99

10-
We pick models by task:
10+
Codebuff runs an orchestrator agent that spawns specialized subagents. Each subagent uses a model suited to its task.
1111

12-
- **Claude Opus 4.5** - Primary model for default and max modes
13-
- **Grok 4.1 Fast** - Used in lite mode for speed
14-
- **GPT-5** - Used for certain editing tasks
15-
- **Gemini 2.5 Pro/Flash** - File discovery and thinking tasks
16-
- **Relace AI** - Speculative decoding for fast file rewrites
12+
## Orchestrator
1713

18-
See [Modes](/docs/tips#modes) for how each mode uses different model configurations.
14+
The main agent ("Buffy") coordinates everything:
15+
16+
| Mode | Model |
17+
|------|-------|
18+
| Default | Claude Opus 4.5 |
19+
| Max | Claude Opus 4.5 |
20+
| Lite | Grok 4.1 Fast |
21+
22+
## Subagents
23+
24+
The orchestrator spawns these for specific jobs:
25+
26+
| Task | Models |
27+
|------|--------|
28+
| Code editing | Claude Opus 4.5, GPT-5.1 |
29+
| Thinking/reasoning | Claude Opus 4.5, GPT-5.1, Gemini 2.5 Pro |
30+
| Code review | Claude Sonnet 4.5, GPT-5.1 |
31+
| File discovery | Gemini 2.0 Flash, Grok 4 Fast |
32+
| Terminal commands | Claude Haiku 4.5 |
33+
| Context management | GPT-5 Mini |
34+
| Web/docs research | Grok 4 Fast |
35+
36+
Max mode runs multiple implementations in parallel and picks the best one. Default mode runs a single implementation pass. Lite mode skips validation steps for speed.
37+
38+
File rewrites use speculative decoding from Relace AI.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# More on the Way
22

3-
More stories are coming. Want to share yours? Ping us on [Discord](https://discord.gg/mcWTGjgTj3) or email [founders@codebuff.com](mailto:founders@codebuff.com).
3+
More stories are coming. Want to share yours? Ping us on [Discord](https://codebuff.com/discord) or email [founders@codebuff.com](mailto:founders@codebuff.com).

web/src/content/help/faq.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ codebuff --create minecraft-simple
2727

2828
## What model does Codebuff use?
2929

30-
Multiple models: Claude Opus 4.5 and Claude Sonnet 4.5 for most coding, GPT-5 for quick edits, Gemini 2.5 Pro/Flash for discovery and thinking tasks, plus speculative decoding from Relace AI for faster file rewrites.
30+
Multiple. The orchestrator uses Claude Opus 4.5 (or Grok 4.1 Fast in lite mode). Subagents use GPT-5.1 for editing and thinking, Gemini 2.0/2.5 for file discovery and reasoning, Claude Haiku 4.5 for terminal commands, and Relace AI for fast file rewrites. See [What models do you use?](/docs/advanced#what-models-do-you-use) for the full breakdown.
3131

3232
## Do you store my data?
3333

@@ -43,7 +43,7 @@ If you want isolation, use the [Dockerfile](https://github.com/CodebuffAI/codebu
4343

4444
## Can I specify custom instructions for Codebuff?
4545

46-
Yes. Add `knowledge.md` files to describe patterns, constraints, and commands. Files ending in `knowledge.md` load automatically. Codebuff updates existing ones but won't create them unless you ask.
46+
Yes. Add `knowledge.md` files to describe patterns, constraints, and commands. Codebuff also reads `AGENTS.md` and `CLAUDE.md` if present. Per directory, it picks one: `knowledge.md` first, then `AGENTS.md`, then `CLAUDE.md`. Codebuff updates existing knowledge files but won't create them unless you ask.
4747

4848
## Can I tell Codebuff to ignore certain files?
4949

@@ -86,6 +86,6 @@ See [Codebuff vs Claude Code](/docs/advanced#codebuff-vs-claude-code) for a deta
8686

8787
## I have more questions!
8888

89-
Contact [support@codebuff.com](mailto:support@codebuff.com) or [join our Discord](https://discord.gg/mcWTGjgTj3).
89+
Contact [support@codebuff.com](mailto:support@codebuff.com) or [join our Discord](https://codebuff.com/discord).
9090

9191
Having technical issues? Check out our [Troubleshooting](/docs/advanced#troubleshooting) guide for solutions to common problems.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ Run Codebuff in your project directory:
2525
codebuff
2626
```
2727

28+
Codebuff has multiple [modes](/docs/help#modes): `--lite` for quick tasks, `--max` for complex work, and `--plan` for planning without file changes.
29+
2830
## Troubleshooting Install
2931

3032
If you run into issues during installation:

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

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

2020
## Planning
2121

22-
Codebuff can outline work before editing. Drop a rough description of the feature, then ask it to turn that into a plan in `plan.md`. Review and adjust the plan, then point Codebuff at it when you start coding.
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.
23+
24+
See [Modes](/docs/help#modes) for details on plan mode and other options.
2325

2426
## Include docs by link
2527

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Commands inside Codebuff:
2424
- `--max`: more context for hard work
2525
- `--plan`: plan only, no file changes
2626

27-
See [Modes](/docs/tips#modes) for details on each mode.
27+
See [Modes](/docs/help#modes) for details on each mode.
2828

2929
## Terminal commands
3030

web/src/content/tips/modes.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: 'Modes'
3-
section: 'tips'
3+
section: 'help'
44
tags: ['modes', 'lite', 'max', 'plan', 'configuration']
5-
order: 1
5+
order: 2
66
---
77

88
# Modes

0 commit comments

Comments
 (0)