Skip to content

Commit 7d03e11

Browse files
committed
Improve documentation with proper internal links between pages and cross-references
- Remove .md extensions from links (per .clinerules guidelines) - Add cross-references between related documentation sections - Add links to newly created documentation pages - Add reference to Context Window management in context mentions documentation
1 parent 9ec130e commit 7d03e11

File tree

7 files changed

+13
-11
lines changed

7 files changed

+13
-11
lines changed

docs/advanced-usage/custom-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Roo Code allows you to customize its behavior using custom instructions at both
99

1010
## Preferred Language
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+
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. For more details on managing this and other settings, see [Managing Preferences and Settings](managing-preferences).
1313

1414
## Global Custom Instructions
1515

docs/advanced-usage/custom-rules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Custom rules are guidelines stored in special files in your project's root direc
1212
- Error handling approaches
1313
- Project-specific conventions
1414

15-
Unlike general custom instructions, rules are typically more structured and focused on specific technical requirements.
15+
Unlike general [custom instructions](custom-instructions), rules are typically more structured and focused on specific technical requirements.
1616

1717
## Rule File Types
1818

@@ -237,7 +237,7 @@ Review and update your rules as your project evolves:
237237

238238
For an even more tailored experience, you can:
239239

240-
1. Create a custom mode with specific capabilities
240+
1. Create a [custom mode](custom-modes) with specific capabilities
241241
2. Create matching `.clinerules-[mode]` file
242242
3. Get specialized assistance that follows your guidelines
243243

docs/advanced-usage/experimental-features.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This is an alternate diff editing strategy to the standard search-and-replace al
3636

3737
This will automatically save a checkpoint to git whenever you make changes to files.
3838

39-
This lets you easily restore a previous state of the files if anything goes wrong.
39+
This lets you easily restore a previous state of the files if anything goes wrong. For more details, see [Checkpoints](checkpoints).
4040

4141
**When to use it:** Enable this feature when:
4242
- You're making extensive changes to your codebase
@@ -72,7 +72,7 @@ Adds a new tool for inserting content at any position in a file.
7272

7373
### Power Steering
7474

75-
When enabled, Roo will remind the model about the details of its current mode definition more frequently. This will lead to stronger adherence to role definitions and custom instructions, but will use more tokens per message.
75+
When enabled, Roo will remind the model about the details of its current mode definition more frequently. This will lead to stronger adherence to role definitions and custom instructions, but will use more tokens per message. For more on how this affects token usage, see [Managing the Context Window](managing-context-window).
7676

7777
**When to use it:** Enable this feature when:
7878
- You need strict adherence to coding standards

docs/advanced-usage/managing-context-window.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ This limits how much terminal output Roo can see when you use `@terminal`:
4949

5050
### Power Steering (Experimental)
5151

52-
**Setting**: `powerSteering`
52+
**Setting**: `powerSteering`
5353

54-
When enabled, Roo will remind itself about its current mode and instructions more frequently.
54+
When enabled, Roo will remind itself about its current mode and instructions more frequently. See [Experimental Features](experimental-features) for more information.
5555
- **Enabled**: Stronger adherence to instructions but uses more context space
5656
- **Disabled**: More context available for content but potentially less consistent adherence
5757

@@ -61,7 +61,7 @@ When enabled, Roo will remind itself about its current mode and instructions mor
6161

6262
**Setting**: `mcpEnabled`
6363

64-
When enabled, Roo includes MCP server information in the context.
64+
When enabled, Roo includes [MCP](mcp) server information in the context.
6565
- **Enabled**: Access to MCP tools but uses some context space
6666
- **Disabled**: Saves context space but no MCP capabilities
6767

docs/advanced-usage/managing-preferences.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ These control more technical aspects of Roo:
7373

7474
### Experimental Features
7575

76-
As covered in [Experimental Features](experimental-features.md), these settings enable cutting-edge capabilities that are still under development.
76+
As covered in [Experimental Features](experimental-features), these settings enable cutting-edge capabilities that are still under development.
7777

7878
## Project-Specific Settings
7979

@@ -162,6 +162,8 @@ Some settings significantly affect token usage:
162162
| Preferred Language | Minimal impact |
163163
| MCP Enabled | Increases if MCP servers are complex |
164164

165+
For more detailed information on how these settings affect your context window, see [Managing the Context Window](managing-context-window).
166+
165167
If you're concerned about token usage or costs, consider:
166168
- Disabling Power Steering
167169
- Reducing Max Open Tabs Context to 5-10

docs/advanced-usage/mcp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ If server operations are slow:
153153

154154
## Disabling MCP Features
155155

156-
Roo Code provides two settings to control the use of MCP servers, to help you manage token usage and security:
156+
Roo Code provides two settings to control the use of MCP servers, to help you manage token usage and security. For a complete overview of all settings, see [Managing Preferences and Settings](managing-preferences):
157157

158158
### 1. Disable MCP Servers Entirely
159159

docs/basic-usage/context-mentions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Context Mentions
22

3-
Context mentions are a powerful way to provide Roo Code with specific information about your project, allowing it to perform tasks more accurately and efficiently. You can use mentions to refer to files, folders, problems, and Git commits. Context mentions start with the `@` symbol.
3+
Context mentions are a powerful way to provide Roo Code with specific information about your project, allowing it to perform tasks more accurately and efficiently. You can use mentions to refer to files, folders, problems, and Git commits. Context mentions start with the `@` symbol. Effective use of context mentions can help manage your available [context window](../advanced-usage/managing-context-window) more efficiently.
44

55
## Types of Mentions
66

0 commit comments

Comments
 (0)