Skip to content

Commit ca79a14

Browse files
committed
fix: resolve merge conflicts in PR #297 - keep comprehensive Fireworks AI documentation from main
2 parents 069f711 + 433e2fc commit ca79a14

File tree

13 files changed

+261
-42
lines changed

13 files changed

+261
-42
lines changed

docs/features/checkpoints.mdx

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Access checkpoint settings in Roo Code settings under the "Checkpoints" section:
6161

6262
## How Checkpoints Work
6363

64-
Roo Code captures snapshots of your project's state using a shadow Git repository, separate from your main version control system. These snapshots, called checkpoints, automatically record changes throughout your AI-assisted workflow—whenever tasks begin, files change, or commands run.
64+
Roo Code captures snapshots of your project's state using a shadow Git repository, separate from your main version control system. These snapshots, called checkpoints, are automatically created **before** file modifications occur, ensuring you can always undo unwanted changes. Checkpoints are recorded throughout your AI-assisted workflow—when tasks begin, before files change, and before commands run.
6565

6666
Checkpoints are stored as Git commits in the shadow repository, capturing:
6767

@@ -77,12 +77,12 @@ Checkpoints are stored as Git commits in the shadow repository, capturing:
7777

7878
Checkpoints are integrated directly into your workflow through the chat interface.
7979

80-
Checkpoints appear directly in your chat history in two forms:
80+
Checkpoints appear directly in your chat history:
8181

82-
- **Initial checkpoint** marks your starting project state
83-
<img src="/img/checkpoints/checkpoints-1.png" alt="Initial checkpoint indicator in chat" width="500" />
82+
- **Task checkpoint** marks your starting project state
83+
<img src="/img/checkpoints/checkpoints-1.png" alt="Task checkpoint indicator in chat" width="500" />
8484

85-
- **Regular checkpoints** appear after file modifications or command execution
85+
- **Regular checkpoints** are created before file modifications or command execution, allowing easy undo of any changes
8686
<img src="/img/checkpoints/checkpoints-2.png" alt="Regular checkpoint indicator in chat" width="500" />
8787

8888
Each checkpoint provides two primary functions:
@@ -128,6 +128,7 @@ To restore a project to a previous checkpoint state:
128128
- **External changes**: Modifications made outside of tasks (manual edits, other tools) aren't included
129129
- **Large files**: Very large binary files may impact performance
130130
- **Unsaved work**: Restoration will overwrite any unsaved changes in your workspace
131+
- **Timing**: Checkpoints are created before changes are applied, providing a safety net for all modifications
131132

132133
---
133134

docs/features/codebase-indexing.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,8 @@ The color of the icon indicates the state:
139139
- 🔴 **Red**: **Error**. An issue has occurred (e.g., failed to connect to Qdrant or the embedding provider). See the Troubleshooting section for help.
140140
- ⚪ **Gray**: **Standby**. The indexer is waiting for configuration or has been disabled.
141141
142+
**Multi-Folder Workspaces**: In multi-folder workspaces, each folder maintains its own indexing status and configuration. The status icon reflects the combined state of all workspace folders.
143+
142144
### The Configuration Popover
143145
144146
Clicking the status icon opens the main configuration popover. Here, you can view the detailed status and manage all settings.
@@ -239,6 +241,7 @@ The indexer respects your project's ignore patterns:
239241
- **Smart Updates**: Only reprocesses modified files
240242
- **Branch Aware**: Automatically handles Git branch switches
241243
- **Hash-based Caching**: Avoids reprocessing unchanged content
244+
- **Multi-Folder Workspaces**: Each folder in a multi-folder workspace maintains its own index with separate settings and status
242245

243246
---
244247

@@ -336,7 +339,6 @@ The tool provides:
336339
## Current Limitations
337340

338341
- **File Size**: 1MB maximum per file
339-
- **Single Workspace**: One workspace indexed at a time
340342
- **External Dependencies**: Requires embedding provider + Qdrant
341343
- **Language Support**: Best results with Tree-sitter supported languages
342344

docs/features/task-todo-list.mdx

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Todo lists appear in multiple places:
7979

8080
<img src="/img/task-todo-list/task-todo-list-2.png" alt="Interactive todo list tool block in chat" width="600" />
8181

82-
3. **Environment Details**: Todo lists appear as a "REMINDERS" table in the environment_details section, giving the AI persistent access to current todo state
82+
3. **Environment Details**: Todo lists appear as a "REMINDERS" table in the environment_details section, giving the AI persistent access to current todo state. Note: If the `todoListEnabled` setting is disabled, the reminders section will not appear in environment details.
8383

8484
### Understanding Task Status
8585

@@ -109,7 +109,16 @@ This is an architectural design decision where Roo Code maintains authority over
109109

110110
---
111111

112-
## Auto-Approving Todo List Updates
112+
## Configuration
113+
114+
### Disabling Todo Lists
115+
116+
You can disable todo lists entirely through the `todoListEnabled` setting. When disabled:
117+
- Roo will not create todo lists for any tasks
118+
- The REMINDERS section will not appear in environment details
119+
- Existing todo lists will remain visible but won't be updated
120+
121+
### Auto-Approving Todo List Updates
113122

114123
You can enable automatic approval of todo list updates to reduce interruptions during long workflows. When enabled, Roo will automatically update task progress without requiring confirmation for each change.
115124

docs/providers/anthropic.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,9 @@ Anthropic is an AI safety and research company that builds reliable, interpretab
3636

3737
Roo Code supports the following Anthropic Claude models:
3838

39+
* `claude-opus-4-1-20250805`
3940
* `claude-opus-4-20250514`
40-
* `claude-opus-4-20250514:thinking` (Extended Thinking variant)
4141
* `claude-sonnet-4-20250514` (Recommended)
42-
* `claude-sonnet-4-20250514:thinking` (Extended Thinking variant)
4342
* `claude-3-7-sonnet-20250219`
4443
* `claude-3-7-sonnet-20250219:thinking` (Extended Thinking variant)
4544
* `claude-3-5-sonnet-20241022`
@@ -63,7 +62,7 @@ See [Anthropic's Model Documentation](https://docs.anthropic.com/en/docs/about-c
6362

6463
## Tips and Notes
6564

66-
* **Prompt Caching:** Claude 3 models support [prompt caching](https://docs.anthropic.com/en/docs/build-with-claude/prompt-caching), which can significantly reduce costs and latency for repeated prompts.
65+
* **Prompt Caching:** Claude models support [prompt caching](https://docs.anthropic.com/en/docs/build-with-claude/prompt-caching), which can significantly reduce costs and latency for repeated prompts.
6766
* **Context Window:** Claude models have large context windows (200,000 tokens), allowing you to include a significant amount of code and context in your prompts.
6867
* **Pricing:** Refer to the [Anthropic Pricing](https://www.anthropic.com/pricing) page for the latest pricing information.
6968
* **Rate Limits:** Anthropic has strict rate limits based on [usage tiers](https://docs.anthropic.com/en/api/rate-limits#requirements-to-advance-tier). If you're repeatedly hitting rate limits, consider contacting Anthropic sales or accessing Claude through a different provider like [OpenRouter](/providers/openrouter) or [Requesty](/providers/requesty).

docs/providers/bedrock.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Roo Code supports the following models through Bedrock (based on source code):
6161
* `amazon.titan-text-embeddings-v1:0`
6262
* `amazon.titan-text-embeddings-v2:0`
6363
* **Anthropic:**
64+
* `anthropic.claude-opus-4.1-20250514-v1:0`
6465
* `anthropic.claude-opus-4-20250514-v1:0`
6566
* `anthropic.claude-sonnet-4-20250514-v1:0`
6667
* `anthropic.claude-3-7-sonnet-20250219-v1:0`
@@ -119,7 +120,7 @@ Roo Code supports using the reasoning budget (extended thinking) for Anthropic's
119120

120121
To enable the reasoning budget:
121122

122-
1. **Select a supported Claude model** (e.g., `anthropic.claude-3-sonnet-20240229-v1:0`).
123+
1. **Select a supported Claude model** (e.g., `anthropic.claude-opus-4.1-20250514-v1:0`, `anthropic.claude-3-sonnet-20240229-v1:0`).
123124
2. **Enable Reasoning Mode** in the model settings.
124125
3. **Adjust the thinking budget** to control how much the model should "think".
125126

docs/providers/claude-code.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,12 @@ export CLAUDE_CODE_MAX_OUTPUT_TOKENS=32768 # Set to 32k tokens
9898

9999
The Claude Code provider supports these Claude models:
100100

101-
- **Claude Sonnet 4** (latest, recommended)
102-
- **Claude Opus 4** (most capable)
101+
- **Claude Opus 4.1** (Most capable)
102+
- **Claude Opus 4**
103+
- **Claude Sonnet 4** (Latest, recommended)
103104
- **Claude 3.7 Sonnet**
104105
- **Claude 3.5 Sonnet**
105-
- **Claude 3.5 Haiku** (fast responses)
106+
- **Claude 3.5 Haiku** (Fast responses)
106107

107108
The specific models available depend on your Claude CLI subscription and plan.
108109

docs/providers/fireworks.md

Lines changed: 66 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,102 @@
11
---
22
sidebar_label: Fireworks AI
3-
description: Configure Fireworks AI with Roo Code for fast access to open-source and proprietary AI models. Get started with Llama, Qwen, DeepSeek, and more on a high-performance platform.
3+
description: Use Fireworks AI with Roo Code to access state-of-the-art open-source models like Kimi K2, Qwen3, and DeepSeek with large context windows up to 256K tokens.
44
keywords:
55
- fireworks ai
6-
- kimi models
7-
- qwen models
8-
- deepseek models
6+
- fireworks
7+
- kimi k2
8+
- qwen3
9+
- deepseek
910
- roo code
1011
- api provider
11-
- ai models
12-
- language models
13-
- llm api
1412
- open source models
15-
- serverless models
13+
- ai models
14+
- openai compatible
1615
image: /img/social-share.jpg
1716
---
1817

1918
# Using Fireworks AI With Roo Code
2019

21-
Fireworks AI is a high-performance platform for running AI models that offers fast access to a wide range of open-source and proprietary language models. Built for speed and reliability, Fireworks AI provides both serverless and dedicated deployment options with OpenAI-compatible APIs.
20+
Fireworks AI provides access to state-of-the-art open-source language models through their optimized infrastructure. The provider offers cost-effective alternatives to proprietary AI services with context windows up to 256,000 tokens.
2221

2322
**Website:** [https://fireworks.ai/](https://fireworks.ai/)
2423

2524
---
2625

2726
## Getting an API Key
2827

29-
1. **Sign Up/Sign In:** Go to [Fireworks AI](https://fireworks.ai/) and create an account or sign in.
30-
2. **Navigate to API Keys:** After logging in, go to the [API Keys page](https://app.fireworks.ai/settings/users/api-keys) in the account settings.
31-
3. **Create a Key:** Click "Create API key" and give your key a descriptive name (e.g., "Roo Code").
32-
4. **Copy the Key:** Copy the API key *immediately* and store it securely. You will not be able to see it again.
28+
1. **Sign Up/Sign In:** Go to [Fireworks AI](https://fireworks.ai/). Create an account or sign in.
29+
2. **Navigate to Dashboard:** Access your account dashboard.
30+
3. **Generate API Key:** Create a new API key from the dashboard.
31+
4. **Copy the Key:** **Important:** Copy the API key immediately and store it securely.
3332

3433
---
3534

3635
## Supported Models
3736

38-
Roo Code supports the following Fireworks AI models:
39-
40-
* `accounts/fireworks/models/kimi-k2-instruct` - Kimi K2 instruction-tuned model
41-
* `accounts/fireworks/models/qwen3-235b-a22b-instruct-2507` - Qwen 3 235B instruction-tuned model
42-
* `accounts/fireworks/models/qwen3-coder-480b-a35b-instruct` - Qwen 3 Coder 480B for code generation
43-
* `accounts/fireworks/models/deepseek-r1-0528` - DeepSeek R1 reasoning model
44-
* `accounts/fireworks/models/deepseek-v3` - DeepSeek V3 latest generation model
37+
Fireworks AI offers several high-performance models:
38+
39+
### Kimi K2
40+
* `accounts/fireworks/models/kimi-k2-instruct` (Default)
41+
- 1 trillion total parameters with 32B activated params
42+
- 128K context window
43+
- Optimized for agentic capabilities
44+
- $0.60/M input, $2.50/M output
45+
46+
### Qwen3 Series
47+
* `accounts/fireworks/models/qwen3-235b-a22b-instruct-2507`
48+
- 256K context window
49+
- Competitive with closed-source models
50+
- $0.22/M input, $0.88/M output
51+
52+
* `accounts/fireworks/models/qwen3-coder-480b-a35b-instruct`
53+
- 256K context window
54+
- Specialized for coding tasks
55+
- $0.45/M input, $1.80/M output
56+
57+
### DeepSeek Series
58+
* `accounts/fireworks/models/deepseek-r1-0528`
59+
- 160K context window
60+
- Advanced reasoning with reduced hallucination
61+
- Function calling support
62+
- $3.00/M input, $8.00/M output
63+
64+
* `accounts/fireworks/models/deepseek-v3`
65+
- 128K context window
66+
- 671B total parameters with 37B activated
67+
- $0.90/M input, $0.90/M output
4568

4669
---
4770

4871
## Configuration in Roo Code
4972

5073
1. **Open Roo Code Settings:** Click the gear icon (<Codicon name="gear" />) in the Roo Code panel.
5174
2. **Select Provider:** Choose "Fireworks AI" from the "API Provider" dropdown.
52-
3. **Enter API Key:** Paste your Fireworks AI API key into the "Fireworks AI API Key" field.
53-
4. **Select Model:** Choose your desired model from the "Model" dropdown.
75+
3. **Enter API Key:** Paste your Fireworks API key into the "Fireworks API Key" field.
76+
4. **Model Selection:** The default model (Kimi K2) is automatically selected. You can change it from the model dropdown if needed.
77+
78+
---
79+
80+
## Model Selection Guide
81+
82+
Choose models based on your needs:
83+
84+
| Model | Best For | Context | Price |
85+
|-------|----------|---------|-------|
86+
| **Kimi K2** | General tasks, balanced performance | 128K | Mid-range |
87+
| **Qwen3 235B** | Cost-effective general use | 256K | Budget-friendly |
88+
| **Qwen3 Coder** | Code generation and debugging | 256K | Mid-range |
89+
| **DeepSeek R1** | Complex reasoning, function calling | 160K | Premium |
90+
| **DeepSeek V3** | Strong general performance | 128K | Balanced |
5491

5592
---
5693

5794
## Tips and Notes
5895

59-
* **Performance:** Fireworks AI is optimized for speed and offers excellent performance for both chat and completion tasks.
60-
* **Pricing:** Refer to the [Fireworks AI Pricing](https://fireworks.ai/pricing) page for current pricing information.
61-
* **Rate Limits:** Fireworks AI has usage-based rate limits. Monitor your usage in the dashboard and consider upgrading your plan if needed.
96+
* **Cost-Effective:** Fireworks AI offers significantly lower pricing than proprietary models while maintaining competitive performance.
97+
* **Large Context Windows:** Most models support 128K-256K tokens, suitable for processing large documents and maintaining extended conversations.
98+
* **OpenAI Compatibility:** The provider uses an OpenAI-compatible API format with streaming support and usage tracking.
99+
* **Text-Only:** All models are text-only without image support or prompt caching capabilities.
100+
* **Default Temperature:** Uses 0.5 temperature by default for balanced creativity and consistency.
101+
* **API Keys:** Stored locally on your machine for security.
102+
* **Pricing:** See the [Fireworks AI pricing page](https://fireworks.ai/pricing) for current rates. Prices shown are per million tokens.

docs/providers/vertex.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,8 @@ Roo Code supports the following models through Vertex AI (based on source code):
4848
* `gemini-1.5-flash-002`
4949
* `gemini-1.5-pro-002`
5050
* **Anthropic Claude Models:**
51-
* `claude-opus-4@20250514:thinking`
51+
* `claude-opus-4-1@20250805`
5252
* `claude-opus-4@20250514`
53-
* `claude-sonnet-4@20250514:thinking`
5453
* `claude-sonnet-4@20250514`
5554
* `claude-3-7-sonnet@20250219:thinking`
5655
* `claude-3-7-sonnet@20250219`

docs/providers/zai.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
sidebar_label: Z AI
3+
description: Configure Z AI models in Roo Code. Access GLM-4.5 series models with region-aware routing for international and China mainland users.
4+
keywords:
5+
- z ai
6+
- zai
7+
- zhipu ai
8+
- glm-4.5
9+
- roo code
10+
- api provider
11+
- china ai
12+
- international ai
13+
- openai compatible
14+
image: /img/social-share.jpg
15+
---
16+
17+
# Using Z AI With Roo Code
18+
19+
Z AI (Zhipu AI) provides advanced language models with the GLM-4.5 series. The provider offers region-aware routing with separate endpoints for international users and China mainland users.
20+
21+
**Website:** [https://www.z.ai/](https://www.z.ai/) (International) | [https://open.bigmodel.cn/](https://open.bigmodel.cn/) (China)
22+
23+
---
24+
25+
## Getting an API Key
26+
27+
### International Users
28+
29+
1. **Sign Up/Sign In:** Go to [https://www.z.ai/](https://www.z.ai/). Create an account or sign in.
30+
2. **Navigate to API Keys:** Access your account dashboard and find the API keys section.
31+
3. **Create a Key:** Generate a new API key for your application.
32+
4. **Copy the Key:** **Important:** Copy the API key immediately and store it securely.
33+
34+
### China Mainland Users
35+
36+
1. **Sign Up/Sign In:** Go to [https://open.bigmodel.cn/](https://open.bigmodel.cn/). Create an account or sign in.
37+
2. **Navigate to API Keys:** Access your account dashboard and find the API keys section.
38+
3. **Create a Key:** Generate a new API key for your application.
39+
4. **Copy the Key:** **Important:** Copy the API key immediately and store it securely.
40+
41+
---
42+
43+
## Supported Models
44+
45+
Z AI provides different model catalogs based on your selected region:
46+
47+
### International Models
48+
* GLM-4.5 series models
49+
* GLM-4.5-Air models
50+
51+
### China Mainland Models
52+
* GLM-4.5 series models
53+
* GLM-4.5-Air models
54+
55+
The specific model availability may vary by region. The appropriate models will be available in the dropdown once you select your region.
56+
57+
---
58+
59+
## Configuration in Roo Code
60+
61+
1. **Open Roo Code Settings:** Click the gear icon (<Codicon name="gear" />) in the Roo Code panel.
62+
2. **Select Provider:** Choose "Z AI" from the "API Provider" dropdown.
63+
3. **Select Region:** Choose your region:
64+
- "International" for global access
65+
- "China" for mainland China access
66+
4. **Enter API Key:** Paste your Z AI API key into the "Z AI API Key" field.
67+
5. **Select Model:** Choose your desired model from the "Model" dropdown. Available models depend on your selected region.
68+
69+
---
70+
71+
## Tips and Notes
72+
73+
* **Region Selection:** The region setting determines both the API endpoint and available models:
74+
- International: Uses `https://api.z.ai/api/paas/v4`
75+
- China: Uses `https://open.bigmodel.cn/api/paas/v4`
76+
* **OpenAI Compatibility:** Z AI uses an OpenAI-compatible API, providing streaming responses and usage reporting.
77+
* **Model Selection:** Models are automatically filtered based on your selected region to ensure compatibility.
78+
* **API Key Required:** A valid API key is required for all requests. Ensure you've obtained one from the appropriate regional platform.
79+
* **Pricing:** Check the respective regional websites for current pricing information.

docs/update-notes/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ This section contains notes about recent updates to Roo Code, listed by version
1919

2020
## Version 3.25
2121

22+
* [3.25.7](/update-notes/v3.25.7) (2025-08-05)
2223
* [3.25.6](/update-notes/v3.25.6) (2025-08-02)
2324
* [3.25.5](/update-notes/v3.25.5) (2025-08-01)
2425
* [3.25.4](/update-notes/v3.25.4) (2025-07-31)

0 commit comments

Comments
 (0)