Skip to content

Commit 7255f54

Browse files
Advanced usage refactor: Stage 1 (#81)
* Enhance API Configuration Profiles documentation with detailed setup instructions and new images * Add custom modes images for enhanced documentation visuals * Enhance Custom Instructions documentation with detailed explanations and new images * Enhance API Configuration Profiles documentation with improved image formatting for clarity * Fix formatting of images in custom modes documentation for improved readability
1 parent ce04f3c commit 7255f54

18 files changed

+245
-95
lines changed

docs/advanced-usage/api-configuration-profiles.md

Lines changed: 56 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,75 @@
22

33
API Configuration Profiles allow you to create and switch between different sets of AI settings. Each profile can have different configurations for each mode, letting you optimize your experience based on the task at hand.
44

5+
:::info
6+
Having multiple configuration profiles lets you quickly switch between different AI providers, models, and settings without reconfiguring everything each time you want to change your setup.
7+
:::
58
## How It Works
69

710
Configuration profiles can have their own:
8-
- API providers (OpenAI, Anthropic, etc.)
9-
- API keys
10-
- Model selections
11+
- API providers (OpenAI, Anthropic, OpenRouter, Glama, etc.)
12+
- API keys and authentication details
13+
- Model selections (o3-mini-high, Claude 3.7 Sonnet, DeepSeek R1, etc.)
1114
- Temperature settings
1215
- Thinking budgets
16+
- Provider-specific settings
1317

14-
This lets you optimize your model configuration for different modes. For instance, you might want Architect and Debug mode to use a more powerful/expensive model to come up with a great plan, while Code mode uses a more standard coding model.
18+
Note that available settings vary by provider and model. Each provider offers different configuration options, and even within the same provider, different models may support different parameter ranges or features.
1519

16-
## Setting Up Profiles
20+
## Creating and Managing Profiles
1721

18-
1. Open Settings → Providers
19-
2. Choose a Configuration Profile from the dropdown, or create a new one
20-
3. Configure the profile's provider, model, key, and parameters
22+
### Creating a Profile
2123

22-
## Linking Profiles to Modes
24+
1. Open Settings by clicking the gear icon <Codicon name="gear" /> → Providers
25+
2. Click the "+" button next to the profile selector
26+
27+
<img src="/img/api-configuration-profiles/api-configuration-profiles-1.png" alt="Profile selector with plus button" width="550" />
28+
3. Enter a name for your new profile
29+
30+
<img src="/img/api-configuration-profiles/api-configuration-profiles.png" alt="Creating a new profile dialog" width="550" />
31+
4. Configure the profile settings:
32+
- Select your API provider
33+
34+
<img src="/img/api-configuration-profiles/api-configuration-profiles-2.png" alt="Provider selection dropdown" width="550" />
35+
- Enter API key
36+
37+
<img src="/img/api-configuration-profiles/api-configuration-profiles-3.png" alt="API key entry field" width="550" />
38+
- Choose a model
39+
40+
<img src="/img/api-configuration-profiles/api-configuration-profiles-8.png" alt="Model selection interface" width="550" />
41+
- Adjust model parameters
42+
43+
<img src="/img/api-configuration-profiles/api-configuration-profiles-5.png" alt="Model parameter adjustment controls" width="550" />
44+
45+
### Switching Profiles
46+
47+
Switch profiles in two ways:
48+
1. From Settings panel: Select a different profile from the dropdown
49+
50+
<img src="/img/api-configuration-profiles/api-configuration-profiles-7.png" alt="Profile selection dropdown in Settings" width="550" />
51+
2. During chat: Access the API Configuration dropdown in the chat interface
2352

24-
In the <Codicon name="notebook" /> Prompts tab, you can associate a Configuration Profile with each Mode.
53+
<img src="/img/api-configuration-profiles/api-configuration-profiles-9.png" alt="API Configuration dropdown in chat interface" width="550" />
2554

26-
## Benefits
55+
### Editing and Deleting Profiles
2756

28-
- **Cost optimization**: Use premium models only where they add the most value
29-
- **Performance tailoring**: Match model capabilities to each mode's specific needs
30-
- **Workflow optimization**: Seamless transitions between modes with appropriate settings
57+
<img src="/img/api-configuration-profiles/api-configuration-profiles-10.png" alt="Profile editing interface" width="550" />
58+
- Select the profile in Settings to modify any settings
59+
- Click the pencil icon to rename a profile
60+
- Click the trash icon to delete a profile (you cannot delete the only remaining profile)
61+
62+
## Linking Profiles to Modes
63+
In the <Codicon name="notebook" /> Prompts tab, you can explicitly associate a specific Configuration Profile with each Mode. The system also automatically remembers which profile you last used with each mode, making your workflow more efficient.
64+
<img src="/img/api-configuration-profiles/api-configuration-profiles-11.png" alt="Profile-Mode association interface in Prompts tab" width="550" />
65+
66+
## Security Note
67+
68+
API keys are stored securely in VSCode's Secret Storage and are never exposed in plain text.
3169

3270
## Related Features
3371

34-
- Works with [custom modes](custom-modes)
72+
- Works with [custom modes](custom-modes) you create
3573
- Integrates with [local models](local-models) for offline work
36-
- Supports [temperature settings](model-temperature) per mode
74+
- Supports [temperature settings](model-temperature) per mode
75+
- Enhances cost management with [rate limits and usage tracking](rate-limits-costs)
76+

docs/advanced-usage/custom-instructions.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,57 @@
11
# Custom Instructions
22

3-
Roo Code allows you to customize its behavior using custom instructions at both global and workspace levels. These instructions are added to the system prompt and influence how Roo Code responds to your requests. You can define:
3+
Custom Instructions allow you to personalize how Roo behaves, providing specific guidance that shapes responses, coding style, and decision-making processes.
44

5-
* **Global Custom Instructions:** Apply across all workspaces
6-
* **Workspace-Level Instructions:**
7-
* **Workspace-Wide:** Apply to all modes in the workspace through `.clinerules` files
8-
* **Mode-Specific:** Apply to specific modes in the workspace through files like `.clinerules-code`
5+
## What Are Custom Instructions?
96

10-
## Preferred Language
7+
Custom Instructions define specific behaviors, preferences, and constraints beyond Roo's basic role definition. Examples include coding style, documentation standards, testing requirements, and workflow guidelines.
8+
:::info Rules Files
9+
Custom Instructions are simply .rules files. They use the common convention of `.clinerules`, `.cursorrules`, and `.windsurfrules` files, which can be placed in your workspace root for version control or configured through the UI.
10+
:::
1111

12-
You can specify a preferred language for Roo Code to use. When set, this appears at the start of your custom instructions and directs Roo Code to communicate in your chosen language. You can set this in the **Prompts** tab.
12+
## Setting Custom Instructions
1313

14-
## Global Custom Instructions
14+
### Global Custom Instructions
1515

16-
These instructions apply across all workspaces. They're useful for setting preferences that you want to maintain regardless of which project you're working on.
16+
These instructions apply across all workspaces and maintain your preferences regardless of which project you're working on.
1717

1818
**How to set them:**
1919

20+
<img src="/img/custom-instructions/custom-instructions.png" alt="Roo Code Prompts tab showing global custom instructions interface" width="600" />
2021
1. **Open Prompts Tab:** Click the <Codicon name="notebook" /> icon in the Roo Code top menu bar
2122
2. **Find Section:** Find the "Custom Instructions for All Modes" section
2223
3. **Enter Instructions:** Enter your instructions in the text area
2324
4. **Save Changes:** Click "Done" to save your changes
2425

25-
## Workspace-Level Instructions
26+
### Workspace-Level Instructions
2627

2728
These instructions only apply within your current workspace, allowing you to customize Roo Code's behavior for specific projects.
2829

29-
### Workspace-Wide Instructions
30+
#### Workspace-Wide Instructions
3031

3132
Workspace-wide instructions are defined through rule files in your workspace root, primarily using `.clinerules`. Additional support for `.cursorrules` and `.windsurfrules` is available for editor compatibility.
3233

33-
### Mode-Specific Instructions
34+
#### Mode-Specific Instructions
3435

3536
Mode-specific instructions can be set in two independent ways that can be used simultaneously:
3637

3738
1. **Using the Prompts Tab:**
39+
40+
<img src="/img/custom-instructions/custom-instructions-2.png" alt="Roo Code Prompts tab showing mode-specific custom instructions interface" width="600" />
3841
* **Open Tab:** Click the <Codicon name="notebook" /> icon in the Roo Code top menu bar
3942
* **Select Mode:** Under the Modes heading, click the button for the mode you want to customize
4043
* **Enter Instructions:** Enter your instructions in the text area under "Mode-specific Custom Instructions (optional)"
4144
* **Save Changes:** Click "Done" to save your changes
4245

46+
:::info Global Mode Rules
47+
If the mode itself is global (not workspace-specific), any custom instructions you set for it will also apply globally for that mode across all workspaces.
48+
:::
49+
4350
2. **Using Rule Files:** Create a `.clinerules-[mode]` file in your workspace root (e.g., `.clinerules-code`)
4451

4552
When both tab instructions and rule files are set for a mode, both sets of instructions will be included in the system prompt.
4653

47-
### How Instructions are Combined
54+
## How Instructions are Combined
4855

4956
Instructions are placed in the system prompt in this exact format:
5057

@@ -63,7 +70,7 @@ Rules:
6370
[.windsurfrules rules]
6471
```
6572

66-
### About Rule Files
73+
## Rules about .rules files
6774

6875
* **File Location:** All rule files must be placed in the workspace root directory
6976
* **Empty Files:** Empty or missing rule files are silently skipped
@@ -80,4 +87,10 @@ Rules:
8087
* "Prioritize using the most common library in the community"
8188
* "When adding new features to websites, ensure they are responsive and accessible"
8289

83-
By using custom instructions, you can tailor Roo Code's behavior to match your coding style, project requirements, and personal preferences.
90+
:::tip Pro Tip: File-Based Team Standards
91+
When working in team environments, placing `.clinerules` files under version control allows you to standardize Roo's behavior across your entire development team. This ensures consistent code style, documentation practices, and development workflows for everyone on the project.
92+
:::
93+
94+
## Combining with Custom Modes
95+
96+
For advanced customization, combine with [Custom Modes](custom-modes) to create specialized environments with specific tool access, file restrictions, and tailored instructions.

0 commit comments

Comments
 (0)