Skip to content

Commit 3d9507c

Browse files
Changed layout of menu and sections (#87)
Add client redirects to support changes made to pathways
1 parent 0e230e0 commit 3d9507c

36 files changed

+229
-130
lines changed

.roomodes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"slug": "docs",
55
"name": "Documentation Writer",
66
"roleDefinition": "You are a technical documentation writer who is a seasoned, straightforward, and technically precise expert who prioritizes clarity and efficiency. With 24 years of coding and documentation writing experience, you have a natural conversational style that values concise, no-nonsense communication. Your approach is authentic and candid, focusing relentlessly on user comprehension without overselling features or using ambiguous language. You avoid fluff, ensuring every sentence provides clear value, practical guidance, or actionable steps. The tone remains professional yet approachable, fostering immediate trust through reliability and transparency. You specialize in writing technical documentation for the Visual Studio Code extension Roo Code, using Docusaurus to structure, format, and publish content efficiently. With deep expertise in Markdown and MDX, you optimize documentation for readability, accessibility, and seamless navigation within a static-site environment built on React. It is important to ensure the content is accessible to readers with varying technical proficiencies, including those who may have learning disabilities such as ADD/ADHD, by maintaining clear structure, logical flow, and avoiding unnecessary complexity.",
7-
"customInstructions": "Directness and Clarity: Each documentation entry must begin directly with what users need to know, avoiding introductory filler phrases or unnecessary context.\n\nPrecision and Brevity: Prioritize short, precise explanations and actionable steps. Users should quickly grasp concepts without needing additional clarification.\n\nAuthentic and Natural Tone: Use conversational language that reflects Roo's personality—straightforward, reliable, and trustworthy—without marketing jargon or generic phrases.\n\nPractical Examples: Include practical, realistic examples relevant to experienced developers, avoiding overly basic scenarios or clichéd tasks. Code snippets must be accurate, concise, and ready for immediate use.\n\nConsistent Formatting: Maintain a consistent format throughout, utilizing structured headings, bullet points, and brief paragraphs that facilitate quick scanning and easy comprehension.\n\nAvoid Over-explaining: Assume a reasonable level of technical competence. Do not over-explain basic coding concepts unless essential to understanding a unique Roo Code feature.\n\nProactive Anticipation: Anticipate common questions or misunderstandings proactively. Address potential issues or complexities directly within the relevant sections.\n\nMinimalism in Wording: Eliminate unnecessary adjectives, adverbs, or overly descriptive phrases. Prioritize functional language that enhances clarity and reduces cognitive load.\n\nInternal Links: Always use relative paths for internal links without including .md file extensions.\n\nCode Examples: Ensure all code snippets are clearly formatted and easy to copy-paste, maintaining consistent syntax highlighting and structure.\n\nInsert image placeholder where we need to add images, make sure to include a description of what the photo should be under the placeholder. The final version of the image in the code will always be `<img src=\"/img/installing/installing-2.png\" alt=\"VS Code's Install from VSIX dialog\" width=\"600\" />` and with the folder starting with `/img/`",
7+
"customInstructions": "### Custom Instructions\n\n1. **Directness and Clarity** \n Begin each documentation entry with the most important information users need, avoiding introductory filler or unnecessary context.\n\n2. **Precision and Brevity** \n Favor short, precise explanations and actionable steps. Users should swiftly grasp concepts without requiring additional clarification.\n\n3. **Authentic and Natural Tone** \n Write in a conversational style that reflects Roo's straightforward, reliable, and trustworthy personality—avoiding marketing jargon or generic phrases.\n\n4. **Practical Examples** \n Include realistic examples aimed at experienced developers. Provide accurate, concise code snippets ready for immediate use, avoiding trivial or clichéd demos.\n\n5. **Consistent Formatting** \n Use structured headings, bullet points, and brief paragraphs for easy scanning and comprehension.\n\n6. **Avoid Over-explaining** \n Assume a reasonable level of technical competence. Do not elaborate on basic coding concepts unless it’s essential to clarify a unique Roo Code feature.\n\n7. **Proactive Anticipation** \n Address likely questions or pitfalls within the relevant sections. Incorporate tips or clarifications to prevent common mistakes.\n\n8. **Minimalism in Wording** \n Eliminate unnecessary adjectives, adverbs, or verbose descriptions. Use clear, functional language that reduces cognitive load.\n\n9. **Internal Links** \n Always use **relative paths** for internal links, and **omit the `.md` file extension**. \n Example: \n ```md\n [Link to Guide](../intro/)\n\n\t10.\t@site Alias\n\t•\tFor code imports or special references that need to resolve from the project root, use the @site alias.\n\t•\tExample:\n\nimport Header from '@site/src/components/Header';\n\n\n\t•\tAvoid @site in Markdown links—use relative paths instead.\n\n\t11.\tCode Examples\nProvide clearly formatted code snippets suitable for copy-pasting. Maintain consistent syntax highlighting, indentation, and structure.\n\t12.\tImages\nInsert an image placeholder where needed. Include a brief description of the image below the placeholder. The final image element should follow this format (folder name may vary):\n\n<img src=\"/img/installing/installing-2.png\" alt=\"VS Code's Install from VSIX dialog\" width=\"600\" />\n\n(with the folder starting at /img/)",
88
"groups": [
99
"read",
1010
[

docs/advanced-usage/local-models.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ Roo Code currently supports two main local model providers:
2424
## Setting Up Local Models
2525

2626
For detailed setup instructions, see:
27-
2827
* [Setting up Ollama](/providers/ollama)
2928
* [Setting up LM Studio](/providers/lmstudio)
3029

docs/advanced-usage/mcp.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/advanced-usage/prompt-engineering.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Prompt engineering is the art of crafting effective instructions for AI models l
88
* **Bad:** Fix the code.
99
* **Good:** Fix the bug in the `calculateTotal` function that causes it to return incorrect results.
1010

11-
* **Provide Context:** Use [Context Mentions](../basic-usage/context-mentions) to refer to specific files, folders, or problems.
11+
* **Provide Context:** Use [Context Mentions](/basic-usage/context-mentions) to refer to specific files, folders, or problems.
1212
* **Good:** `@/src/utils.ts` Refactor the `calculateTotal` function to use async/await.
1313

1414
* **Break Down Tasks:** Divide complex tasks into smaller, well-defined steps.
@@ -42,7 +42,7 @@ Custom instructions are added to the system prompt, providing persistent guidanc
4242
* Define project-specific conventions.
4343
* Adjust Roo Code's tone or personality.
4444

45-
See the [Custom Instructions](./custom-instructions) section for more details.
45+
See the [Custom Instructions](/features/custom-instructions) section for more details.
4646

4747
## Handling Ambiguity
4848

docs/advanced-usage/rate-limits-costs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,6 @@ If you set the rate limit to 10 seconds, Roo Code will wait at least 10 seconds
4646
* **Use Custom Instructions:** Provide custom instructions to guide Roo Code's behavior and reduce the need for lengthy explanations in each prompt.
4747
* **Choose the Right Model:** Some models are more cost-effective than others. Consider using a smaller, faster model for tasks that don't require the full power of a larger model.
4848
* **Use Modes:** Different modes can access different tools, for example `Architect` can't modify code, which makes it a safe choice when analyzing a complex codebase, without worrying about accidentally allowing expensive operations.
49-
* **Disable MCP If Not Used:** If you're not using MCP (Model Context Protocol) features, consider [disabling it in the MCP settings](/mcp/using-mcp-in-roo#enabling-or-disabling-mcp-server-creation) to significantly reduce the size of the system prompt and save tokens.
49+
* **Disable MCP If Not Used:** If you're not using MCP (Model Context Protocol) features, consider [disabling it in the MCP settings](/features/mcp/using-mcp-in-roo#enabling-or-disabling-mcp-server-creation) to significantly reduce the size of the system prompt and save tokens.
5050

51-
By understanding and managing your API usage, you can use Roo Code effectively and efficiently.
51+
By understanding and managing your API usage, you can use Roo Code effectively and efficiently.

docs/basic-usage/how-tools-work.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ This safety mechanism ensures you maintain control over which files are modified
8080

8181
## Learn More About Tools
8282

83-
For more detailed information about each tool, including complete parameter references and advanced usage patterns, see the [Advanced Tool Reference](../advanced-usage/tool-reference) documentation.
83+
For more detailed information about each tool, including complete parameter references and advanced usage patterns, see the [Advanced Tool Reference](/features/tool-reference) documentation.

docs/basic-usage/typing-your-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Clearly state what you want Roo Code to do. Avoid vague or ambiguous language.
1111
| Strategy | Implementation |
1212
|----------|----------------|
1313
| **Be specific** | "Fix the bug in `calculateTotal` that returns incorrect results" instead of "Fix the code" |
14-
| **Provide context** | Use @ [Context Mentions](./context-mentions) for file and code references |
14+
| **Provide context** | Use @ [Context Mentions](/basic-usage/context-mentions) for file and code references |
1515
| **Break down tasks** | Submit complex tasks in smaller manageable steps |
1616
| **Include examples** | Provide sample code when you need specific formatting or style |
1717

docs/basic-usage/using-modes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,4 @@ Four ways to switch modes:
7373

7474
## Custom Modes
7575

76-
Create your own specialized assistants by defining tool access, file permissions, and behavior instructions. Custom modes help enforce team standards or create purpose-specific assistants. See [Custom Modes documentation](../advanced-usage/custom-modes) for setup instructions.
76+
Create your own specialized assistants by defining tool access, file permissions, and behavior instructions. Custom modes help enforce team standards or create purpose-specific assistants. See [Custom Modes documentation](/features/custom-modes) for setup instructions.

docs/community.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Inspired by LangMem, this simple Rule allows you to define new rules and delete
2424

2525
## Custom Modes Gallery
2626

27-
Share and discover custom modes created by the community! Learn how to create and configure custom modes in the [Custom Modes documentation](advanced-usage/custom-modes). To add your own custom mode to the gallery, create a pull request from the "Edit this page" link below.
27+
Share and discover custom modes created by the community! Learn how to create and configure custom modes in the [Custom Modes documentation](/features/custom-modes). To add your own custom mode to the gallery, create a pull request from the "Edit this page" link below.
2828

2929
### Jest Test Engineer by [@mrubens](https://github.com/mrubens)
3030

docs/faq.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,11 @@ Roo Code is a powerful tool, and it's important to use it responsibly. Here are
4848

4949
### How do I install Roo Code?
5050

51-
See the [Installation Guide](getting-started/installing) for detailed instructions.
51+
See the [Installation Guide](/getting-started/installing) for detailed instructions.
5252

5353
### Which API providers are supported?
5454

5555
Roo Code supports a wide range of API providers, including:
56-
5756
* [Anthropic (Claude)](/providers/anthropic)
5857
* [OpenAI](/providers/openai)
5958
* [OpenRouter](/providers/openrouter)
@@ -70,40 +69,33 @@ Roo Code supports a wide range of API providers, including:
7069
* [VS Code Language Model API](/providers/vscode-lm)
7170

7271
### How do I get an API key?
73-
7472
Each API provider has its own process for obtaining an API key. See the [Setting Up Your First AI Provider](/getting-started/connecting-api-provider) for links to the relevant documentation for each provider.
7573

7674
### Can I use Roo Code with local models?
77-
7875
Yes, Roo Code supports running models locally using [Ollama](/providers/ollama) and [LM Studio](/providers/lmstudio). See [Using Local Models](/advanced-usage/local-models) for instructions.
7976

8077
## Usage
8178

8279
### How do I start a new task?
83-
8480
Open the Roo Code panel (<Codicon name="rocket" />) and type your task in the chat box. Be clear and specific about what you want Roo Code to do. See [Typing Your Requests](/basic-usage/typing-your-requests) for best practices.
8581

8682
### What are modes in Roo Code?
87-
8883
[Modes](/basic-usage/using-modes) are different personas that Roo Code can adopt, each with a specific focus and set of capabilities. The built-in modes are:
8984

9085
* **Code:** For general-purpose coding tasks.
9186
* **Architect:** For planning and technical leadership.
9287
* **Ask:** For answering questions and providing information.
9388
* **Debug:** For systematic problem diagnosis.
94-
95-
You can also create [Custom Modes](/advanced-usage/custom-modes).
89+
You can also create [Custom Modes](/features/custom-modes).
9690

9791
### How do I switch between modes?
9892

9993
Use the dropdown menu in the chat input area to select a different mode, or use the `/` command to switch to a specific mode.
10094

10195
### What are tools and how do I use them?
102-
10396
[Tools](/basic-usage/how-tools-work) are how Roo Code interacts with your system. Roo Code automatically selects and uses the appropriate tools to complete your tasks. You don't need to call tools directly. You will be prompted to approve or reject each tool use.
10497

10598
### What are context mentions?
106-
10799
[Context mentions](/basic-usage/context-mentions) are a way to provide Roo Code with specific information about your project, such as files, folders, or problems. Use the "@" symbol followed by the item you want to mention (e.g., `@/src/file.ts`, `@problems`).
108100

109101
### Can Roo Code access the internet?
@@ -112,7 +104,7 @@ Yes, if you are using a provider with a model that support web browsing. Be mind
112104

113105
### Can Roo Code run commands in my terminal?
114106

115-
Yes, Roo Code can execute commands in your VS Code terminal. You will be prompted to approve each command before it's executed, unless you've enabled auto-approval for commands. Be extremely cautious about auto-approving commands. If you're experiencing issues with terminal commands, see the [Shell Integration Guide](troubleshooting/shell-integration) for troubleshooting.
107+
Yes, Roo Code can execute commands in your VS Code terminal. You will be prompted to approve each command before it's executed, unless you've enabled auto-approval for commands. Be extremely cautious about auto-approving commands. If you're experiencing issues with terminal commands, see the [Shell Integration Guide](/troubleshooting/shell-integration) for troubleshooting.
116108

117109
### How do I provide feedback to Roo Code?
118110

@@ -128,16 +120,15 @@ Yes, you can customize Roo Code in several ways:
128120
* **Settings:** Adjust various settings, such as auto-approval, diff editing, and more.
129121

130122
### Does Roo Code have any auto approval settings?
131-
Yes, Roo Code has a few settings that when enabled will automatically approve actions. Find out more [here](/advanced-usage/auto-approving-actions).
123+
Yes, Roo Code has a few settings that when enabled will automatically approve actions. Find out more [here](/features/auto-approving-actions).
132124

133125
## Advanced Features
134126

135127
### Can I use Roo offline?
136128
Yes, if you use a [local model](/advanced-usage/local-models).
137129

138130
### What is MCP (Model Context Protocol)?
139-
140-
[MCP](/advanced-usage/mcp) is a protocol that allows Roo Code to communicate with external servers, extending its capabilities with custom tools and resources.
131+
[MCP](/features/mcp/overview) is a protocol that allows Roo Code to communicate with external servers, extending its capabilities with custom tools and resources.
141132

142133
### Can I create my own MCP servers?
143134

0 commit comments

Comments
 (0)