Skip to content

Commit 96dbda2

Browse files
brunobergherellipsis-dev[bot]roomote[bot]mrubenshannesrudolph
authored
General Doc Updates (#453)
Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com> Co-authored-by: roomote[bot] <219738659+roomote[bot]@users.noreply.github.com> Co-authored-by: Matt Rubens <[email protected]> Co-authored-by: Hannes Rudolph <[email protected]>
1 parent e67c37f commit 96dbda2

File tree

12 files changed

+108
-269
lines changed

12 files changed

+108
-269
lines changed

docs/getting-started/connecting-api-provider.md

Lines changed: 18 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -13,86 +13,34 @@ image: /img/social-share.jpg
1313
---
1414
import KangarooIcon from '@site/src/components/KangarooIcon';
1515

16-
# Connecting Your First AI Provider
16+
# Connecting Your First LLM Provider
1717

18-
Roo Code requires an API key from an AI model provider to function. We recommend these options for accessing the powerful **Claude Sonnet 4.5** model:
18+
Roo Code needs an inference provider to access the LLM models that make it work.
1919

20-
- **OpenRouter (Recommended):** Provides access to multiple AI models through a single API key. Ideal for getting started quickly with minimal setup. [View pricing](https://openrouter.ai/models?order=pricing-low-to-high).
21-
- **Anthropic:** Direct access to Claude models. Requires API access approval and may have [rate limits depending on your tier](https://docs.anthropic.com/en/api/rate-limits#requirements-to-advance-tier). See [Anthropic's pricing page](https://www.anthropic.com/pricing#anthropic-api) for details.
20+
A great model to start is **Claude Sonnet 4.5**, which offers a lot of power at a reasonable price point. To get it going, choose a provider:
2221

23-
---
24-
25-
## Getting Your API Key
26-
27-
### Option 1: LLM Routers
28-
29-
LLM routers let you access multiple AI models with one API key, simplifying cost management and switching between models. They often offer [competitive pricing](https://openrouter.ai/models?order=pricing-low-to-high) compared to direct providers.
30-
31-
#### OpenRouter
32-
33-
1. Go to [openrouter.ai](https://openrouter.ai/)
34-
2. Sign in with your Google or GitHub account
35-
3. Navigate to the [API keys page](https://openrouter.ai/keys) and create a new key
36-
4. Copy your API key - you'll need this for Roo Code setup
37-
38-
<img src="/img/connecting-api-provider/connecting-api-provider-4.png" alt="OpenRouter API keys page" width="600" />
39-
40-
*OpenRouter dashboard with "Create key" button. Name your key and copy it after creation.*
41-
42-
#### Requesty
43-
44-
1. Go to [requesty.ai](https://requesty.ai/)
45-
2. Sign in with your Google account or email
46-
3. Navigate to the [API management page](https://app.requesty.ai/api-keys) and create a new key
47-
4. **Important:** Copy your API key immediately as it won't be displayed again
48-
49-
<img src="/img/connecting-api-provider/connecting-api-provider-7.png" alt="Requesty API management page" width="600" />
50-
51-
*Requesty API management page with "Create API Key" button. Copy your key immediately - it's shown only once.*
22+
- **Roo Code Cloud Provider (Recommended):** the easiest way to access multiple providers tested with Roo Code. No API needed. To get started, just choose Roo Code Cloud as a provider and follow instructions. [Learn more about it](/roo-code-provider/overview).
5223

53-
### Option 2: Direct Providers
24+
- **OpenRouter:** Provides access to multiple AI models from different labs through a single API key. Great for flexibility and getting started reasonably fast. To get an API key, [follow these instructions <LucideIcon name="ArrowRight" />](/providers/openrouter#getting-an-api-key)
5425

55-
For direct access to specific models from their original providers, with full access to their features and capabilities:
26+
- **Anthropic:** Direct access to the Claude family of models. Requires API access approval and may have [rate limits depending on your tier](https://docs.anthropic.com/en/api/rate-limits#requirements-to-advance-tier). To get an API key, [follow these instructions <LucideIcon name="ArrowRight" />](/providers/anthropic#getting-an-api-key)
5627

57-
#### Anthropic
28+
Roo Code is compatible with [other providers](/providers/index) which offer Claude, and with a wide range of different models you can try.
5829

59-
1. Go to [console.anthropic.com](https://console.anthropic.com/)
60-
2. Sign up for an account or log in
61-
3. Navigate to the [API keys section](https://console.anthropic.com/settings/keys) and create a new key
62-
4. **Important:** Copy your API key immediately as it won't be displayed again
63-
64-
<img src="/img/connecting-api-provider/connecting-api-provider-5.png" alt="Anthropic console API Keys section" width="600" />
65-
66-
*Anthropic console API Keys section with "Create key" button. Name your key, set expiration, and copy it immediately.*
67-
68-
#### OpenAI
69-
70-
1. Go to [platform.openai.com](https://platform.openai.com/)
71-
2. Sign up for an account or log in
72-
3. Navigate to the [API keys section](https://platform.openai.com/api-keys) and create a new key
73-
4. **Important:** Copy your API key immediately as it won't be displayed again
74-
75-
<img src="/img/connecting-api-provider/connecting-api-provider-6.png" alt="OpenAI API keys page" width="600" />
30+
:::info Model Selection Advice
31+
We recommend **Claude Sonnet 4.5** because it "just works" out of the box for most tasks. We use it internally a lot.
7632

77-
*OpenAI platform with "Create new secret key" button. Name your key and copy it immediately after creation.*
33+
You can choose other models, but that introduces complexity. Different models vary in how they follow tool instructions, parse formats, and maintain context through multi-step operations, so it may be better to try them later. If you do experiment with other models, choose ones specifically designed for structured reasoning and tool use.
34+
:::
7835

7936
---
8037

81-
## Configuring Roo Code in VS Code
82-
83-
Once you have your API key:
84-
85-
1. Open the Roo Code sidebar by clicking the Roo Code icon (<KangarooIcon />) in the VS Code Activity Bar
86-
2. In the welcome screen, select your API provider from the dropdown
87-
3. Paste your API key into the appropriate field
88-
4. Select your model:
89-
- For **OpenRouter**: select `anthropic/claude-sonnet-4-5` ([model details](https://openrouter.ai/anthropic/claude-sonnet-4-5))
90-
- For **Anthropic**: select `claude-sonnet-4-5` ([model details](https://www.anthropic.com/pricing#anthropic-api))
38+
## Configuring the provider in VS Code
9139

92-
:::info Model Selection Advice
93-
We strongly recommend **Claude Sonnet 4.5** for the best experience—it generally "just works" out of the box. Roo Code has been extensively optimized for this model's capabilities and instruction-following behavior.
94-
95-
Selecting alternative models is an advanced feature that introduces complexity. Different models vary significantly in how they follow tool instructions, parse formats, and maintain context through multi-step operations. If you do experiment with other models, choose ones specifically designed for structured reasoning and tool use.
96-
:::
40+
1. Open the Roo Code panel by clicking the Roo Code icon (<KangarooIcon />) in the VS Code Activity Bar
41+
2. In the welcome screen, choose your LLM provider.
42+
3. If you choose the Roo Code Cloud provider, just connect your account and choose `anthropic/claude-sonnet-4-5` from the dropdown. You're set.
43+
4. If you chose another provider, paste the API key you copied from it into the right field and continue
44+
5. Select your model (it should be called `claude-sonnet-4-5` or `anthropic/claude-sonnet-4-5`) and complete the process.
9745

98-
5. Click "Let's go!" to save your settings and start using Roo Code
46+
Now you can start coding!

docs/getting-started/your-first-task.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ image: /img/social-share.jpg
1111
---
1212
import KangarooIcon from '@site/src/components/KangarooIcon';
1313

14-
# Starting Your First Task with Roo Code
14+
# Your first task
1515

1616
Now that you've [configured your AI provider and model](/getting-started/connecting-api-provider), you're ready to start using Roo Code! This guide walks you through your first interaction.
1717

@@ -21,11 +21,10 @@ Now that you've [configured your AI provider and model](/getting-started/connect
2121

2222
Click the Roo Code icon (<KangarooIcon />) in the VS Code Activity Bar (vertical bar on the side of the window) to open the chat interface. If you don't see the icon, verify the extension is installed and enabled.
2323

24-
<img src="/img/your-first-task/your-first-task.png" alt="Roo Code icon in VS Code Activity Bar" width="800" />
25-
26-
*The Roo Code icon in the Activity Bar opens the chat interface.*
27-
28-
---
24+
<figure>
25+
<img src="/img/your-first-task/your-first-task.png" alt="Roo Code icon in VS Code Activity Bar" width="600" />
26+
<figcaption>The Roo Code icon in the Activity Bar opens the chat interface. You can drag it to position Roo elsewhere.</figcaption>
27+
</figure>
2928

3029
## Step 2: Type Your Task
3130

@@ -37,17 +36,15 @@ Type a clear, concise description of what you want Roo Code to do in the chat bo
3736

3837
No special commands or syntax needed—just use plain English.
3938

40-
<img src="/img/your-first-task/your-first-task-6.png" alt="Typing a task in the Roo Code chat interface" width="500" />
41-
*Enter your task in natural language - no special syntax required.*
42-
43-
---
39+
<figure>
40+
<img src="/img/your-first-task/your-first-task-6.png" alt="Typing a task in the Roo Code chat interface" width="400" />
41+
<figcaption>Enter your task in natural language - no special syntax required.</figcaption>
42+
</figure>
4443

4544
## Step 3: Send Your Task
4645

4746
Press Enter or click the Send icon (<Codicon name="send" />) to the right of the input box.
4847

49-
---
50-
5148
## Step 4: Review and Approve Actions
5249

5350
Roo Code analyzes your request and proposes specific actions. These may include:
@@ -58,22 +55,26 @@ Roo Code analyzes your request and proposes specific actions. These may include:
5855
* **Using the Browser:** Outlines browser actions (click, type, etc.)
5956
* **Asking questions:** Requests clarification when needed to proceed
6057

61-
<img src="/img/your-first-task/your-first-task-7.png" alt="Reviewing a proposed file creation action" width="800" />
62-
*Roo Code shows exactly what action it wants to perform and waits for your approval.*
58+
59+
<figure>
60+
<img src="/img/your-first-task/your-first-task-7.png" alt="Reviewing a proposed file creation action" width="800" />
61+
<figcaption>Roo Code shows exactly what action it wants to perform and waits for your approval.</figcaption>
62+
</figure>
6363

6464
**Each action requires your explicit approval** (unless auto-approval is enabled):
6565

6666
* **Approve:** Click the "Approve" button to execute the proposed action
6767
* **Reject:** Click the "Reject" button and provide feedback if needed
6868

69-
---
7069

7170
## Step 5: Iterate
7271

7372
Roo Code works iteratively. After each action, it waits for your feedback before proposing the next step. Continue this review-approve cycle until your task is complete.
7473

75-
<img src="/img/your-first-task/your-first-task-8.png" alt="Final result of a completed task showing the iteration process" width="500" />
76-
*After completing the task, Roo Code shows the final result and awaits your next instruction.*
74+
<figure>
75+
<img src="/img/your-first-task/your-first-task-8.png" alt="Final result of a completed task showing the iteration process" width="500" />
76+
<figcaption>After completing the task, Roo Code shows the final result and awaits your next instruction.</figcaption>
77+
</figure>
7778

7879
---
7980

docs/providers/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The Roo Code VS Code extension and Roo Code Cloud Agents are highly capable, sop
1818

1919
Other tools are intinsically bound by design to a specific provider (like Claude Code → Anthropic Models or Codex → OpenAI models), forcing you to stick with them irrespective of how the landscape changes (which happens fast). Roo on the other hand is **model-agnostic**, allowing you to choose the model that best fits your needs, according to your budget, skill profile, codebase and more.
2020

21-
So we support connting to a wide range of model providers, giving you flexibility in how you access AI models. Some providers work with the VS Code extension, while others are available through Roo Code Cloud Agents.
21+
We support connecting to a wide range of model providers, giving you flexibility in how you access AI models. Some providers work with the VS Code extension, while others are available through Roo Code Cloud Agents.
2222

2323
Learn how to set up your provider in [the Roo Code VS Code extension here](/getting-started/connecting-api-provider).
2424

@@ -37,4 +37,4 @@ Yeah, it's a lot.
3737
- **Want it to JustWork™?** Go with the [Roo Code Cloud Provider](/roo-code-provider/overview) for a curated selection and the easiest setup with no API keys required
3838
- **Want access to many models?** Try [OpenRouter](/providers/openrouter) for a single API to 100+ models
3939
- **Want to optimize for specific models?** Use the first part provider for each of them (Anthropic, OpenAI, etc)
40-
- **Looking for local/offline models?** Check out [Ollama](/providers/ollama) or [LM Studio](/providers/lmstudio)
40+
- **Looking for local/offline models?** Check out [Ollama](/providers/ollama) or [LM Studio](/providers/lmstudio)

docs/providers/roo-code-cloud.md

Lines changed: 7 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ description: The easiest way to get started with AI coding. Access premium model
44
keywords:
55
- roo code cloud
66
- roo provider
7-
- grok-code-fast-1
8-
- code-supernova
97
- free ai models
108
- easy setup
119
- no api key
@@ -14,71 +12,13 @@ image: /img/social-share.jpg
1412

1513
# Roo Code Cloud Provider
1614

17-
**The Easiest Way to Get Started with AI Coding**
15+
To make it as smooth as possible to use Roo Code, which depends on a provider service for LLM inference, we've built the Roo Code Cloud Provider.
1816

19-
Roo Code Cloud removes the complexity of setting up AI providers. Forget about API keys, credit cards, and complex configuration. Just sign in and start coding with premium models for **FREE**.
17+
There's no need for a separate subscription or managing API keys. It's fully integrated into our suite of products and easy to get started. It features:
2018

21-
[Learn more about the provider here.](/roo-code-provider/overview)
19+
- Both free and paid models
20+
- Only models tested to work well with Roo
21+
- Paid models provided at cost, with no mark-up
22+
- The same pre-paid credit mechanism you'll use for Roo Code Cloud Agents
2223

23-
## Why Choose Roo Code Cloud?
24-
25-
- **Zero Configuration**: No API keys to manage. Just sign in with GitHub, Google, or email.
26-
- **No Credit Card Required**: Get started immediately without entering payment details.
27-
- **Free Premium Models**: Access powerful models like `grok-code-fast-1` and `code-supernova` at no cost during our promotional period.
28-
- **Instant Access**: Start coding in seconds.
29-
30-
## Available Models
31-
32-
We curate the best models for coding and offer them directly to you.
33-
34-
### grok-code-fast-1
35-
*(Formerly roo/sonic)*
36-
- **Best for:** Fast coding, quick edits, and high-speed iterations.
37-
- **Speed:** Extremely Fast
38-
- **Context:** 262k tokens
39-
- **Pricing:** **FREE** (Promotional)
40-
41-
### roo/code-supernova
42-
- **Best for:** Complex reasoning, multimodal tasks (images), and deep architectural planning.
43-
- **Capabilities:** Supports image analysis (multimodal).
44-
- **Context:** 200k tokens
45-
- **Pricing:** **FREE** (Promotional)
46-
47-
## How to Connect
48-
49-
1. **Sign In**: Click the account icon (<Codicon name="account" />) in the Roo Code extension sidebar and sign in. See [Connect Guide](/roo-code-cloud/connect) if needed.
50-
2. **Select Provider**:
51-
- Open Settings (<Codicon name="gear" />).
52-
- In the **API Provider** dropdown, select **Roo Code Cloud**.
53-
3. **Start Coding**: Choose your model and start your first task!
54-
55-
## Pricing & Credits
56-
57-
Roo Code Cloud operates on a [Credit System](/roo-code-cloud/billing-subscriptions).
58-
- **Promotional Period**: Currently, all standard usage for the models listed above is **100% FREE**.
59-
- **Future Pricing**: We will introduce a transparent credit-based system for usage beyond the free tier. You will always be notified before any charges apply.
60-
61-
:::info
62-
Within Roo Code, free access is only through Roo Code Cloud provider. Using the [xAI provider](/providers/xai) for `grok-code-fast-1` will incur standard charges once pricing is established.
63-
:::
64-
65-
## Comparison with Other Providers
66-
67-
| Feature | Roo Code Cloud | Direct Providers (OpenAI/Anthropic/xAI) |
68-
| :--- | :--- | :--- |
69-
| **Setup** | One-click Sign In | Requires API Keys |
70-
| **Payment** | Free (Promo) / Credits | Credit Card / Monthly Bill |
71-
| **Configuration** | Automatic | Manual |
72-
| **Model Selection** | Curated Best-in-Class | All Available Models |
73-
74-
## Troubleshooting
75-
76-
**"Authentication required"**: Connect to Roo Code Cloud via the account icon.
77-
78-
**"No session token"**: Sign out and back in to refresh your session.
79-
80-
**Connection issues**: Check internet connection and restart VS Code if needed.
81-
82-
---
83-
84-
[Get Started Now](/roo-code-cloud/connect)
24+
[Learn more and how to get started <LucideIcon name="ArrowRight" />](/roo-code-provider/overview)

docs/roo-code-cloud/billing-subscriptions.mdx

Lines changed: 0 additions & 59 deletions
This file was deleted.

docs/roo-code-cloud/cloud-agents.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,12 @@ image: /img/social-share.jpg
1818

1919
Cloud Agents are specialized, autonomous AI workers that run in the cloud.
2020

21-
It upends the way most people think about software development: instead of a highly specialized activity that can only happen in a specialized IDE, it encapsulates the relevant aspects of each part of the process into agents that can run on their own (but will take your guidance if you choose).
21+
They upend the way most people think about software development: instead of a highly specialized activity that can only happen in a specialized IDE, it encapsulates the relevant aspects of each part of the process into agents that can run on their own (but will take your guidance if you choose).
2222

2323
In other words: instead of doing all of your learning, investigating, coding, testing and shipping from your IDE, you can delegate work to focused agents which operate as a team. And it's your choice how much you lean into it.
2424

25+
Cloud Agents are available in all Roo Code Cloud plans, including the free one.
26+
2527
Sounds like wishful thinking? Read on and we'll show you how to use them.
2628

2729
---

0 commit comments

Comments
 (0)