Skip to content

Commit 8a55ef8

Browse files
MichaelzagMichaelzag
committed
Merge branch 'docs-enhancements' of github.com:Michaelzag/Roo-Code-Docs into docs-enhancements
2 parents efd53a5 + 8f87375 commit 8a55ef8

File tree

2 files changed

+143
-0
lines changed

2 files changed

+143
-0
lines changed

‎original_custom_instructions.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Custom Instructions
2+
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:
4+
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`
9+
10+
## Preferred Language
11+
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.
13+
14+
## Global Custom Instructions
15+
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.
17+
18+
**How to set them:**
19+
20+
1. **Open Prompts Tab:** Click the <Codicon name="notebook" /> icon in the Roo Code top menu bar
21+
2. **Find Section:** Find the "Custom Instructions for All Modes" section
22+
3. **Enter Instructions:** Enter your instructions in the text area
23+
4. **Save Changes:** Click "Done" to save your changes
24+
25+
## Workspace-Level Instructions
26+
27+
These instructions only apply within your current workspace, allowing you to customize Roo Code's behavior for specific projects.
28+
29+
### Workspace-Wide Instructions
30+
31+
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.
32+
33+
### Mode-Specific Instructions
34+
35+
Mode-specific instructions can be set in two independent ways that can be used simultaneously:
36+
37+
1. **Using the Prompts Tab:**
38+
* **Open Tab:** Click the <Codicon name="notebook" /> icon in the Roo Code top menu bar
39+
* **Select Mode:** Under the Modes heading, click the button for the mode you want to customize
40+
* **Enter Instructions:** Enter your instructions in the text area under "Mode-specific Custom Instructions (optional)"
41+
* **Save Changes:** Click "Done" to save your changes
42+
43+
2. **Using Rule Files:** Create a `.clinerules-[mode]` file in your workspace root (e.g., `.clinerules-code`)
44+
45+
When both tab instructions and rule files are set for a mode, both sets of instructions will be included in the system prompt.
46+
47+
### How Instructions are Combined
48+
49+
Instructions are placed in the system prompt in this exact format:
50+
51+
```
52+
====
53+
USER'S CUSTOM INSTRUCTIONS
54+
The following additional instructions are provided by the user, and should be followed to the best of your ability without interfering with the TOOL USE guidelines.
55+
[Language Preference (if set)]
56+
[Global Instructions]
57+
[Mode-specific Instructions]
58+
59+
Rules:
60+
[.clinerules-{mode} rules]
61+
[.clinerules rules]
62+
[.cursorrules rules]
63+
[.windsurfrules rules]
64+
```
65+
66+
### About Rule Files
67+
68+
* **File Location:** All rule files must be placed in the workspace root directory
69+
* **Empty Files:** Empty or missing rule files are silently skipped
70+
* **Source Headers:** Each rule file's contents are included with a header indicating its source
71+
* **Rule Interaction:** Mode-specific rules complement global rules rather than replacing them
72+
73+
## Examples of Custom Instructions
74+
75+
* "Always use spaces for indentation, with a width of 4 spaces"
76+
* "Use camelCase for variable names"
77+
* "Write unit tests for all new functions"
78+
* "Explain your reasoning before providing code"
79+
* "Focus on code readability and maintainability"
80+
* "Prioritize using the most common library in the community"
81+
* "When adding new features to websites, ensure they are responsive and accessible"
82+
83+
By using custom instructions, you can tailor Roo Code's behavior to match your coding style, project requirements, and personal preferences.

‎pull-request.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Documentation Updates
2+
3+
## Overview
4+
5+
This PR adds expanded content to existing documentation and introduces new guides covering additional topics. The changes add examples, use cases, and configuration information to help users understand Roo-Code features. Additionally, we've implemented proper cross-linking between related documentation pages to improve navigation.
6+
7+
## Changes
8+
9+
### Updated Documents:
10+
11+
1. **Context Mentions** (`basic-usage/context-mentions.md`)
12+
- Added usage patterns for combining mention types
13+
- Added examples for common workflows
14+
- Added optimization tips
15+
- Added link to context window management documentation
16+
17+
2. **Experimental Features** (`advanced-usage/experimental-features.md`)
18+
- Added guidance on when to use each experimental feature
19+
- Added examples showing practical applications
20+
- Added troubleshooting information
21+
- Added links to related documentation (Checkpoints, Context Window)
22+
23+
3. **MCP Server Integration** (`advanced-usage/mcp.md`)
24+
- Added examples of common MCP server types
25+
- Enhanced configuration options section
26+
- Added troubleshooting section
27+
- Added link to managing preferences documentation
28+
29+
4. **Custom Instructions** (`advanced-usage/custom-instructions.md`)
30+
- Expanded and merged content from the previously separate Custom Rules document
31+
- Added comprehensive comparison between custom instructions and rules approaches
32+
- Added detailed examples of rule file formats with proper markdown formatting
33+
- Included project-specific rule examples for various types of projects
34+
- Added best practices for effective customization with clear examples
35+
- Added section on advanced usage with custom modes
36+
- Added guidance on when to use each customization approach
37+
- Added link to managing preferences documentation
38+
39+
### New Documents:
40+
41+
1. **Managing Preferences** (`advanced-usage/managing-preferences.md`)
42+
- Overview of Roo-Code settings
43+
- Recommended configurations for different workflows
44+
- Troubleshooting guidance
45+
- Added links to experimental features and context window documentation
46+
47+
2. **Managing Context Window** (`advanced-usage/managing-context-window.md`)
48+
- Explanation of context window functionality
49+
- Settings that affect context usage
50+
- Optimization strategies
51+
- Added links to experimental features and MCP documentation
52+
53+
### Documentation Standards:
54+
55+
All documentation links strictly adhere to the standards defined in .clinerules:
56+
- No .md extensions in documentation links
57+
- Relative paths for internal documentation links
58+
- Consistent link format throughout
59+
60+
The documentation follows the existing style and structure to maintain consistency across the project while improving navigation between related topics.

0 commit comments

Comments
 (0)