Skip to content

Commit 4cd6bfa

Browse files
authored
Update docs to reflect change to .roorules (#119)
* Update docs to reflect change to .roorules * Update custom-instructions.md
1 parent be4c1a6 commit 4cd6bfa

File tree

3 files changed

+11
-16
lines changed

3 files changed

+11
-16
lines changed

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Yes, you can customize Roo Code in several ways:
116116

117117
* **Custom Instructions:** Provide general instructions that apply to all modes, or mode-specific instructions.
118118
* **Custom Modes:** Create your own modes with tailored prompts and tool permissions.
119-
* **`.clinerules` Files:** Create `.clinerules` files in your project to provide additional guidelines.
119+
* **`.roorules` Files:** Create `.roorules` files in your project to provide additional guidelines.
120120
* **Settings:** Adjust various settings, such as auto-approval, diff editing, and more.
121121

122122
### Does Roo Code have any auto approval settings?

docs/features/custom-instructions.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ Custom Instructions allow you to personalize how Roo behaves, providing specific
55
## What Are Custom Instructions?
66

77
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-
:::
118

129
## Setting Custom Instructions
1310

@@ -29,7 +26,7 @@ These instructions only apply within your current workspace, allowing you to cus
2926

3027
#### Workspace-Wide Instructions
3128

32-
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.
29+
Workspace-wide instructions can be defined in a `.roorules` file in your workspace root.
3330

3431
#### Mode-Specific Instructions
3532

@@ -47,7 +44,7 @@ Mode-specific instructions can be set in two independent ways that can be used s
4744
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.
4845
:::
4946

50-
2. **Using Rule Files:** Create a `.clinerules-[mode]` file in your workspace root (e.g., `.clinerules-code`)
47+
2. **Using Rule Files:** Create a `.roorules-[mode]` file in your workspace root (e.g., `.roorules-code`)
5148

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

@@ -64,10 +61,8 @@ The following additional instructions are provided by the user, and should be fo
6461
[Mode-specific Instructions]
6562
6663
Rules:
67-
[.clinerules-{mode} rules]
68-
[.clinerules rules]
69-
[.cursorrules rules]
70-
[.windsurfrules rules]
64+
[.roorules-{mode} rules]
65+
[.roorules rules]
7166
```
7267

7368
## Rules about .rules files
@@ -88,9 +83,9 @@ Rules:
8883
* "When adding new features to websites, ensure they are responsive and accessible"
8984

9085
:::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.
86+
When working in team environments, placing `.roorules` 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.
9287
:::
9388

9489
## Combining with Custom Modes
9590

96-
For advanced customization, combine with [Custom Modes](/features/custom-modes) to create specialized environments with specific tool access, file restrictions, and tailored instructions.
91+
For advanced customization, combine with [Custom Modes](/features/custom-modes) to create specialized environments with specific tool access, file restrictions, and tailored instructions.

docs/features/custom-modes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Custom modes allow you to define:
1818

1919
* **A unique name and slug:** For easy identification
2020
* **A role definition:** Placed at the beginning of the system prompt, this defines Roo's core expertise and personality for the mode. This placement is crucial as it shapes Roo's fundamental understanding and approach to tasks
21-
* **Custom instructions:** Added at the end of the system prompt, these provide specific guidelines that modify or refine Roo's behavior. Unlike `.clinerules` files (which only add rules at the end), this structured placement of role and instructions allows for more nuanced control over Roo's responses
21+
* **Custom instructions:** Added at the end of the system prompt, these provide specific guidelines that modify or refine Roo's behavior. Unlike `.roorules` files (which only add rules at the end), this structured placement of role and instructions allows for more nuanced control over Roo's responses
2222
* **Allowed tools:** Which Roo Code tools the mode can use (e.g., read files, write files, execute commands)
2323
* **File restrictions:** (Optional) Limit file access to specific file types or patterns (e.g., only allow editing `.md` files)
2424

@@ -101,8 +101,8 @@ Common regex patterns:
101101

102102
In addition to the `customInstructions` property in JSON, you can use a dedicated file for mode-specific instructions:
103103

104-
1. Create a file named `.clinerules-{mode-slug}` in your workspace root
105-
* Replace `{mode-slug}` with your mode's slug (e.g., `.clinerules-docs-writer`)
104+
1. Create a file named `.roorules-{mode-slug}` in your workspace root
105+
* Replace `{mode-slug}` with your mode's slug (e.g., `.roorules-docs-writer`)
106106
2. Add your custom instructions to this file
107107
3. Roo Code will automatically apply these instructions to the specified mode
108108

@@ -111,7 +111,7 @@ This approach is particularly useful for:
111111
* Managing instructions with version control
112112
* Allowing non-technical team members to modify instructions without editing JSON
113113

114-
Note: If both `.clinerules-{mode-slug}` and the `customInstructions` property exist, they will be combined, with the file contents appended after the JSON property.
114+
Note: If both `.roorules-{mode-slug}` and the `customInstructions` property exist, they will be combined, with the file contents appended after the JSON property.
115115

116116
## Configuration Precedence
117117

0 commit comments

Comments
 (0)