Skip to content

Commit d6ff512

Browse files
committed
docs: streamline documentation copy and rename Getting Started to Quick Start
1 parent db93dc8 commit d6ff512

26 files changed

+252
-346
lines changed

web/src/components/docs/doc-sidebar.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import { cn } from '@/lib/utils'
1414

1515
const learnSections = [
1616
{
17-
title: 'Getting Started',
17+
title: 'Quick Start',
1818
href: '/docs/help',
1919
subsections: getDocsByCategory('help').map((doc) => ({
2020
title: doc.title,

web/src/content/advanced/claude-code-comparison.mdx

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,48 +7,49 @@ order: 5
77

88
# Codebuff vs Claude Code
99

10-
Anthropic recently released Claude Code, their own AI coding assistant.
10+
Claude Code is Anthropic's first-party coding assistant. Codebuff covers the same basics and adds its own workflow tools.
1111

12-
Both Codebuff and Claude Code:
12+
Both tools:
1313

14-
- Run in your terminal for a seamless coding experience
14+
- Run in your terminal
1515
- Understand your entire codebase context
1616
- Can edit files and execute terminal commands
1717
- Use Claude Sonnet 4 as their primary model
1818

1919
## When to Choose Codebuff
2020

21-
Codebuff might be a better choice if you value:
21+
Pick Codebuff if you want:
2222

23-
- Speed: Codebuff is [nearly 4 times faster](https://x.com/jahooma/status/1894224663817195599)
24-
- Cost: Codebuff is one third the cost of Claude Code for equivalent tasks and even less for back-and-forth conversation
25-
- Codebase Analysis: Codebuff pulls more context from scanning your entire codebase, rather than file-by-file. Codebuff also [blends different models](/docs/advanced#what-models-do-you-use) based on their strengths to provide more accurate results.
26-
- Staying in Flow: Codebuff requires fewer confirmation prompts for file edits and command execution.
27-
- Focused changes: Codebuff does just what you asked for, while Claude Code will often get carried away editing more and more files.
28-
- SDK and Programmatic Access: Codebuff provides a full TypeScript SDK for programmatic integration, allowing you to create custom workflows and embed AI coding capabilities into your own tools.
29-
- Advanced Agent System: Create custom agents with TypeScript generator functions, spawn subagents, and orchestrate complex multi-step workflows that go far beyond simple chat interactions.
23+
- Faster edits and responses ([benchmark](https://x.com/jahooma/status/1894224663817195599))
24+
- Lower credit burn for similar work
25+
- Context pulled from a broad code scan instead of one file at a time
26+
- Fewer confirmation prompts while editing or running commands
27+
- Tight, targeted diffs rather than wide rewrites
28+
- TypeScript SDK and custom agents for scripted workflows
3029

3130
## When to Choose Claude Code
3231

33-
Claude Code might be a better choice if you:
32+
Pick Claude Code if you need:
3433

35-
- You require first-party Anthropic integration (no intermediary/proxy) for procurement, data handling, or legal reasons
36-
- You need enterprise security/compliance controls directly from Anthropic (e.g., SOC 2/ISO programs, data-retention controls, private/VPC networking options)
37-
- Your org needs centralized admin controls within Anthropic's ecosystem (SSO, RBAC, governance, auditability)
38-
- You prioritize early access to Anthropic model capabilities and first-party tooling
34+
- Direct Anthropic access for procurement or data-handling rules
35+
- Enterprise controls handled by Anthropic (SSO, RBAC, compliance programs, private networking)
36+
- Early access to Anthropic features and their management UI
3937

4038
## Feature Comparison
4139

4240
<MarkdownTable>
43-
| Feature | Codebuff | Claude Code | | --- | --- | --- | | CLI-based
44-
interaction | ✅ | ✅ | | Natural language commands | ✅ | ✅ | | Autonomous
45-
test execution | ✅ | ✅ | | Large context window | ✅ (200k-1M) | ✅
46-
(200k-1M) | | Directory-specific context awareness | ✅ | 🔄 | | Fast diff
47-
edits (no full rewrites) | ✅ | ❌ | | Cost | $ | $$ | | Polished UI | ❌ | ✅
48-
| | Minimal interruptions ||| | Full-featured SDK ||| |
49-
Programmatic agent creation | ✅ | ❌ | | Project templates | ✅ | ❌ |
41+
| Feature | Codebuff | Claude Code |
42+
| --- | --- | --- |
43+
| CLI-based interaction |||
44+
| Natural language commands |||
45+
| Runs tests autonomously |||
46+
| Large context window | ✅ (200k-1M) | ✅ (200k-1M) |
47+
| Directory-specific context || 🔄 |
48+
| Diff-focused edits |||
49+
| Cost | $ | $$ |
50+
| Polished UI |||
51+
| Minimal confirmations |||
52+
| Full SDK |||
53+
| Programmatic agents |||
54+
| Project templates |||
5055
</MarkdownTable>
51-
52-
## Summary
53-
54-
Both Codebuff and Claude Code are powerful AI coding assistants that can significantly boost your productivity. Codebuff offers more flexible pricing and performance options, while Claude Code provides direct integration with Anthropic's ecosystem.

web/src/content/advanced/config.mdx

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,21 @@ order: 6
77

88
# Configuration
99

10-
Codebuff can be configured using a `codebuff.json` file in your project root. This file allows you to customize various aspects of how codebuff operates in your project.
10+
Configure Codebuff with `codebuff.json` in your project root.
1111

12-
## Why configure codebuff?
12+
## Why configure Codebuff?
1313

14-
Configuring codebuff helps you create a seamless development environment where codebuff becomes your central development hub. Instead of juggling multiple terminal windows and manually starting various services, you can let codebuff manage your entire development workflow.
14+
It lets Codebuff start your dev stack and keep the workflow in one place instead of juggling terminals.
1515

1616
### Startup Processes
1717

18-
You can configure startup processes, which will run in the background every time codebuff starts! When you use this feature, codebuff will automatically:
18+
Set startup processes that run in the background every time Codebuff starts:
1919

20-
1. Start your development processes:
21-
- Servers (frontend, backend, etc.)
22-
- Launch your database
23-
- Run any other necessary background services
24-
2. Manage all these processes for you
25-
3. Read the logs and outputs and automatically handle any errors that arise
20+
1. Start your servers (frontend, backend, etc.)
21+
2. Launch databases or other services
22+
3. Stream logs and surface errors
2623

27-
This means you can start your day with a single `codebuff` command, write code with codebuff's assistance, and when you're done, closing codebuff will cleanly shut down all your development processes. No more scattered terminal windows or forgotten running processes!
24+
Start Codebuff once, write code, and close it when you're done. It will stop the processes it started.
2825

2926
## Configuration Schema
3027

@@ -34,7 +31,7 @@ The configuration file follows this structure:
3431

3532
## Example Configuration
3633

37-
Here's an example configuration file that starts a development server and database:
34+
Example that starts a dev server and database:
3835

3936
<CodeDemo language="json">
4037
```
@@ -61,10 +58,10 @@ Here's an example configuration file that starts a development server and databa
6158

6259
## Best Practices
6360

64-
1. **Process Names**: Use descriptive names that clearly indicate what each process does.
65-
2. **Working Directories**: Use relative paths for `cwd` to maintain portability.
66-
3. **Logging**: Consider using `stdoutFile` and `stderrFile` for important processes to help with debugging.
67-
4. **Process Management**: Use the `enabled` flag to temporarily disable processes without removing them from the configuration.
61+
1. Name processes clearly.
62+
2. Use relative `cwd` paths so configs travel well.
63+
3. Log important services with `stdoutFile`/`stderrFile`.
64+
4. Toggle processes with `enabled` instead of deleting them.
6865

6966
## Troubleshooting
7067

@@ -75,4 +72,4 @@ If your startup processes aren't working as expected:
7572
3. Check the process output in the specified log files if you've configured them
7673
4. Make sure the JSON syntax in your configuration file is valid
7774

78-
Need more help? Check out our [Troubleshooting](/docs/advanced#troubleshooting) guide or join our [Discord community](https://discord.gg/mcWTGjgTj3).
75+
Need more help? Check [Troubleshooting](/docs/advanced#troubleshooting) or join [Discord](https://discord.gg/mcWTGjgTj3).

web/src/content/advanced/how-does-it-work.mdx

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

88
# How does Codebuff actually work?
99

10-
Codebuff starts by running through the source files in all subdirectories and parsing them with tree-sitter. We use this information to help find relevant files to you requests.
10+
Codebuff scans your repo with tree-sitter and builds a quick index of the code. That index makes it fast to find files when you ask for help.
1111

12-
We have a stateless server that passes messages along to Anthropic, OpenAI, or Gemini and websockets to ferry data back and forth to clients. It effectively acts as a proxy between the client and our LLM providers.
12+
The server is stateless. It proxies requests to Anthropic, OpenAI, or Gemini over websockets and streams results back to the CLI.
1313

14-
We use a fast model to pick the relevant files, and we load them into context Claude Sonnet responds with the right edit. This main agent can also delegate to other agents, as when it does its planning step, or when searching for files.
14+
We use a fast model to pick files, load the right snippets into context, and let Claude Sonnet propose an edit. The main agent can hand work to other agents for planning or file search when needed.

web/src/content/advanced/large-projects.mdx

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,30 @@ order: 4
77

88
# Working with Large Projects
99

10-
In general, Codebuff works quite well in larger projects. For example, we've pulled Codebuff into the VSCode repo (millions of lines of code) and have had no issues in our testing. That said, if you're noticing Codebuff getting stuck/forgetting context too soon or using a ton of credits, here are some tips to help you mitigate those issues.
10+
Codebuff runs fine on very large repos (we test against the VS Code codebase). If it starts to wander or burn too many credits, use the tips below.
1111

1212
## Directory-Based Approach
1313

14-
When working with large codebases, you can start Codebuff from specific directories to maintain focus:
14+
Start Codebuff in the part of the repo you care about:
1515

1616
```bash
1717
cd backend
1818
codebuff
1919
```
2020

21-
Or equivalently without changing directories:
21+
Or set `--cwd`:
2222

2323
```bash
2424
codebuff --cwd backend
2525
```
2626

27-
This helps Codebuff concentrate on relevant files and provide more targeted assistance.
27+
This keeps the context tight.
2828

2929
## Knowledge Organization
3030

31-
For large projects:
31+
For big trees, keep knowledge close to the code:
3232

33-
- Create separate knowledge.md files in key directories, like so:
33+
- Add `knowledge.md` files in important subdirectories:
3434

3535
```
3636
services/
@@ -45,22 +45,22 @@ For large projects:
4545
src/
4646
```
4747

48-
- Focus each knowledge file on its directory's specific concerns
49-
- Link related concepts across knowledge files
50-
- Keep root knowledge.md for project-wide concepts
48+
- Keep each file focused on that area
49+
- Link related files when the areas overlap
50+
- Use the root `knowledge.md` for cross-cutting notes
5151

5252
## Effective Communication
5353

54-
When working with large codebases:
54+
When asking for work in a large repo:
5555

56-
- Be specific about file locations
57-
- Reference related files explicitly
58-
- Break large changes into smaller, focused requests
59-
- Use the `--max` mode for better context understanding by loading more files
56+
- Point to exact paths
57+
- Mention related files up front
58+
- Break large changes into smaller requests
59+
- Use `--max` when you need Codebuff to load more files
6060

6161
## Performance Tips
6262

63-
- Leverage your `.codebuffignore` and `.gitignore` files to exclude irrelevant directories
64-
- Start in subdirectories when possible
65-
- Break large refactoring tasks into smaller chunks
66-
- Let Codebuff handle file discovery instead of listing all files
63+
- Trim noise with `.codebuffignore` and `.gitignore`
64+
- Start in the most relevant subdirectory
65+
- Split broad refactors into stages
66+
- Let Codebuff handle file discovery instead of pasting long file lists

web/src/content/advanced/sdk.mdx

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ order: 7
77

88
# SDK & Programmatic Access
99

10-
The Codebuff SDK (`@codebuff/sdk`) allows you to integrate AI coding capabilities into your own applications, scripts, and workflows programmatically.
10+
The Codebuff SDK (`@codebuff/sdk`) lets you run Codebuff agents from your own code.
1111

1212
## Installation
1313

@@ -66,7 +66,7 @@ import type { AgentDefinition } from '@codebuff/sdk'
6666

6767
const myAgent: AgentDefinition = {
6868
id: 'my-custom-agent',
69-
model: 'anthropic/claude-4-sonnet-20250522',
69+
model: 'anthropic/claude-sonnet-4.5',
7070
displayName: 'My Custom Agent',
7171
toolNames: ['read_files', 'write_file'],
7272
instructionsPrompt: 'You are a helpful coding assistant.',
@@ -175,20 +175,15 @@ Returns a `RunState` object containing:
175175

176176
## Use Cases
177177

178-
The SDK is perfect for:
179-
180-
- **CI/CD Pipelines**: Automated code review, test generation, or refactoring
181-
- **Custom Workflows**: Build your own AI-powered development tools
182-
- **Batch Processing**: Process multiple files or projects programmatically
183-
- **Integration**: Embed Codebuff in VS Code extensions, web apps, or other tools
184-
- **Automation**: Create scripts that leverage AI for repetitive coding tasks
178+
- CI/CD pipelines (code review, test generation, refactoring)
179+
- Batch processing across multiple files
180+
- Embedding in VS Code extensions or web apps
181+
- Scripts for repetitive coding tasks
185182

186183
## Examples
187184

188185
### Test Generation
189186

190-
Automatically generate unit tests for your code:
191-
192187
```typescript
193188
import { CodebuffClient } from '@codebuff/sdk'
194189

@@ -217,9 +212,7 @@ async function generateTests(code: string) {
217212
}
218213
```
219214

220-
### Code Review Automation
221-
222-
Integrate AI code review into your CI/CD pipeline:
215+
### Code Review in CI
223216

224217
```typescript
225218
import { CodebuffClient } from '@codebuff/sdk'
@@ -238,9 +231,7 @@ async function reviewPullRequest(diff: string) {
238231
}
239232
```
240233

241-
### Batch Processing Multiple Files
242-
243-
Process multiple files in sequence while maintaining conversation context:
234+
### Batch Processing
244235

245236
```typescript
246237
import { CodebuffClient } from '@codebuff/sdk'
@@ -275,8 +266,6 @@ await addDocstringsToFiles(files)
275266

276267
### Code Refactoring
277268

278-
Refactor code to use modern patterns:
279-
280269
```typescript
281270
import { CodebuffClient } from '@codebuff/sdk'
282271

@@ -312,8 +301,6 @@ async function refactorCode(code: string) {
312301

313302
### Providing Project Context
314303

315-
Pass project files to give the agent better context:
316-
317304
```typescript
318305
import { CodebuffClient } from '@codebuff/sdk'
319306
import * as fs from 'fs'
@@ -339,9 +326,7 @@ async function generateComponentWithContext() {
339326
}
340327
```
341328

342-
### CI/CD Integration (GitHub Actions)
343-
344-
Example GitHub Action workflow for automated code review:
329+
### GitHub Actions Example
345330

346331
```yaml
347332
name: AI Code Review
@@ -370,6 +355,6 @@ jobs:
370355
371356
## Resources
372357
373-
- [GitHub Repository](https://github.com/CodebuffAI/codebuff) - Full source code
358+
- [GitHub Repository](https://github.com/CodebuffAI/codebuff) - Source code
374359
- [Agent Store](https://codebuff.com/store) - Browse available agents
375360
- [API Keys](https://codebuff.com/api-keys) - Get your API key

web/src/content/advanced/troubleshooting.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ order: 1
77

88
# Troubleshooting
99

10-
Can't find what you're looking for? [Open an issue on GitHub](https://github.com/CodebuffAI/codebuff/issues) or check existing issues for solutions.
10+
If you're stuck, [open an issue](https://github.com/CodebuffAI/codebuff/issues) or check existing reports.
1111

1212
## Version
1313

14-
The most latest version of the Codebuff client can be found on the [npm page](https://www.npmjs.com/package/codebuff).
14+
The latest version of the Codebuff client can be found on the [npm page](https://www.npmjs.com/package/codebuff).
1515

1616
Run `codebuff --version` to make sure you're on the latest version.
1717

18-
Note: Codebuff should automatically install the latest version. If you're still having issues, see below.
18+
Codebuff should auto-update. If not, try the steps below.
1919

2020
## Codebuff not updating
2121

@@ -29,13 +29,13 @@ Mac/Linux: `sudo chown -R $(whoami) <directory>`
2929

3030
Windows: `cmd takeown /F <directory> /R /D Y`
3131

32-
Otherwise, try reinstalling node with [nvm or fnm](https://nodejs.org/en/download). Then run the codebuff install command again.
32+
Otherwise reinstall node with [nvm or fnm](https://nodejs.org/en/download) and rerun the install.
3333

3434
## Accessing Your Chat History
3535

3636
Your conversation history with Codebuff is stored locally (and nowhere else) at `~/.config/manicode/projects/<your-project-name>/chats`.
3737

38-
If you need help, we'd love if you include a copy of your recent chats for us to help you troubleshoot!
38+
Include recent chats if you ask for help.
3939

4040
## Common Issues
4141

@@ -62,7 +62,7 @@ it means you're having connection issues. In that case, try:
6262

6363
### Endless Auto-Updates
6464

65-
If Codebuff keeps trying to update itself in an endless loop, there could be several potential causes. Below are known issues and their solutions:
65+
If Codebuff keeps trying to update itself in a loop, check the items below:
6666

6767
#### Conflicting Node/npm Installations (Homebrew vs. nvm)
6868

@@ -160,6 +160,6 @@ tmux send-keys -t my-session Enter
160160

161161
If you're still experiencing issues:
162162

163-
1. [Open an issue on GitHub](https://github.com/CodebuffAI/codebuff/issues) - Codebuff is open source, so you can also browse the code to understand how things work
164-
2. Join our [Discord community](https://codebuff.com/discord) for real-time help from other users
165-
3. Contact us at [support@codebuff.com](mailto:support@codebuff.com)please note we prioritize paying users, but we'll likely reply within a week
163+
1. [Open an issue on GitHub](https://github.com/CodebuffAI/codebuff/issues)
164+
2. Join the [Discord community](https://codebuff.com/discord)
165+
3. Contact [support@codebuff.com](mailto:support@codebuff.com)replies may take a few days

0 commit comments

Comments
 (0)