Skip to content

Commit 42ab923

Browse files
Misc (#134)
* docs: clarify folder mention behavior and add important interactions * docs: add mention of currently open files in context mentions dropdown * docs: add note about handling empty override files in footgun prompting * docs: add model selection advice for Claude 3.7 Sonnet in API provider guide * docs: refine model selection advice for Claude 3.7 Sonnet in API provider guide * docs: add comprehensive installation guide for Roo Code extension
1 parent ce900b4 commit 42ab923

File tree

4 files changed

+37
-9
lines changed

4 files changed

+37
-9
lines changed

docs/basic-usage/context-mentions.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Context mentions are a powerful way to provide Roo Code with specific informatio
4444
|------------|---------|
4545
| **Format** | `@/path/to/folder` (no trailing slash) |
4646
| **Provides** | Complete contents of all files within the directory |
47-
| **Includes** | Contents of all files directly within the folder (not recursive) |
47+
| **Includes** | Contents of non-binary text files directly within the folder (not recursive) |
4848
| **Best for** | Providing context from multiple files in a directory |
4949
| **Tip** | Be mindful of context window limits when mentioning large directories |
5050

@@ -109,14 +109,18 @@ The dropdown automatically suggests:
109109
- Visible folders
110110
- Recent git commits
111111
- Special keywords (`problems`, `terminal`, `git-changes`)
112+
- **All currently open files** (regardless of ignore settings or directory filters)
112113

113-
## Best Practices
114+
The dropdown automatically filters out common directories like `node_modules`, `.git`, `dist`, and `out` to reduce noise, even though their content could be included if manually typed.
114115

115-
| Practice | Description |
116+
## Important Behaviors
117+
118+
### Ignore File Interactions
119+
120+
| Behavior | Description |
116121
|----------|-------------|
117-
| **Use specific paths** | Reference exact files rather than describing them |
118-
| **Use relative paths** | Always start from workspace root: `@/src/file.ts` not `@C:/Projects/src/file.ts` |
119-
| **Verify references** | Ensure paths and commit hashes are correct |
120-
| **Click mentions** | Click mentions in chat history to open files or view content |
121-
| **Eliminate copy-pasting** | Use mentions instead of manually copying code or errors |
122-
| **Combine mentions** | "Fix @problems in @/src/component.ts using the pattern from commit @a1b2c3d" |
122+
| **`.rooignore` bypass** | File and folder `@mentions` bypass `.rooignore` checks when fetching content for context. Content from ignored files will be included if directly mentioned. |
123+
| **`.gitignore` bypass** | Similarly, file and folder `@mentions` do not respect `.gitignore` rules when fetching content. |
124+
| **Git command respect** | Git-related mentions (`@git-changes`, `@commit-hash`) do respect `.gitignore` since they rely on Git commands. |
125+
126+

docs/features/footgun-prompting.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ You can find the option and instructions within the Roo Code UI:
4646
- **Impact on Functionality:** Custom prompts override standard instructions, including those for tool usage and response consistency. This can cause unexpected behavior or errors if not managed carefully.
4747
- **Mode-Specific:** Each override file applies only to the mode specified in its filename (`{mode-slug}`).
4848
- **No File, No Override:** If the `.roo/system-prompt-{mode-slug}` file doesn't exist, Roo Code uses the standard system prompt generation process for that mode.
49+
- **Blank Files Ignored:** If the override file exists but is empty (blank), it will be ignored and the default system prompt will be used.
4950
- **Directory Creation:** Roo Code ensures the `.roo` directory exists before attempting to read or create the override file.
5051
5152
Use this feature cautiously. While powerful for customization, incorrect implementation can significantly degrade Roo Code's performance and reliability for the affected mode.

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,11 @@ Once you have your API key:
7373
4. Select your model:
7474
- For **OpenRouter**: select `anthropic/claude-3.7-sonnet` ([model details](https://openrouter.ai/anthropic/claude-3.7-sonnet))
7575
- For **Anthropic**: select `claude-3-7-sonnet-20250219` ([model details](https://www.anthropic.com/pricing#anthropic-api))
76+
77+
:::info Model Selection Advice
78+
We strongly recommend **Claude 3.7 Sonnet** 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.
79+
80+
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.
81+
:::
82+
7683
5. Click "Let's go!" to save your settings and start using Roo Code
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@ sidebar_label: Installing Roo Code
44

55
# Installing Roo Code
66

7+
<div style={{ position: 'relative', paddingBottom: '56.25%', height: 0, overflow: 'hidden' }}>
8+
<iframe
9+
src="https://www.youtube.com/embed/Mcq3r1EPZ-4"
10+
style={{
11+
position: 'absolute',
12+
top: 0,
13+
left: 0,
14+
width: '100%',
15+
height: '100%',
16+
}}
17+
frameBorder="0"
18+
allow="autoplay; encrypted-media"
19+
allowFullScreen
20+
></iframe>
21+
</div>
22+
723
Roo Code is a VS Code extension that brings AI-powered coding assistance directly to your editor. Install using one of these methods:
824
1. **VS Code Marketplace (Recommended)** - fastest method for standard VS Code and Cursor users
925
2. **Open VSX Registry** - for VS Code-compatible editors like VSCodium

0 commit comments

Comments
 (0)