You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Redirects required when moving docs ([docusaurus.config.ts](docusaurus.config.ts:109-271)); onBrokenLinks won't fail builds but creates poor UX.
8
8
- Constants centralized in [src/constants.ts](src/constants.ts) for all external URLs. Never hardcode URLs in config or components.
9
-
-PostHog analytics conditionally loaded based on env var ([docusaurus.config.ts](docusaurus.config.ts:84-93)); architectural decision for privacy/GDPR.
9
+
-No analytics or support-chat runtime providers are configured; keep the site focused on open-source documentation surfaces.
10
10
- Search uses local plugin (@easyops-cn/docusaurus-search-local) with docsRouteBasePath "/" - maintain consistency.
11
-
- No blog feature (disabled in preset); this is pure documentation site, not a content platform.
11
+
- No blog feature (disabled in preset); this is pure documentation site, not a content platform.
Copy file name to clipboardExpand all lines: .roo/rules-code/AGENTS.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,6 @@ This file provides guidance to agents when working with code in this repository.
9
9
- When moving docs, add redirects in [docusaurus.config.ts](docusaurus.config.ts:109); onBrokenLinks is warn ([docusaurus.config.ts](docusaurus.config.ts:40)) so missing redirects won’t fail CI.
10
10
- Internal doc links must be absolute and extensionless per [.roorules](.roorules) (e.g., /basic-usage/how-tools-work).
11
11
- Images in docs must use HTML tags: <imgsrc="/img/...png"alt="..."width="600" /> (Markdown image syntax is disallowed).
12
-
- Builds preload dotenv; PostHog plugin loads only when POSTHOG_API_KEY is set. Use [.env.example](.env.example). See [docusaurus.config.ts](docusaurus.config.ts:83) and [package.json](package.json:7).
12
+
- Builds preload dotenv. No environment variables are required by default; use [.env.example](.env.example) only when adding local-only settings. See [docusaurus.config.ts](docusaurus.config.ts) and [package.json](package.json).
13
13
- Use Node 20 locally to match CI ([.github/workflows/docusaurus-build.yml](.github/workflows/docusaurus-build.yml:23)); package engines allow >=18.
14
-
- “Tutorial Videos” sidebar is driven by [docs/tutorial-videos.json](docs/tutorial-videos.json); titles truncated to 40 chars in [sidebars.ts](sidebars.ts:5).
14
+
- “Tutorial Videos” sidebar is driven by [docs/tutorial-videos.json](docs/tutorial-videos.json); titles truncated to 40 chars in [sidebars.ts](sidebars.ts:5).
Copy file name to clipboardExpand all lines: .roo/rules-debug/AGENTS.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,8 @@
3
3
This file provides guidance to agents when working with code in this repository.
4
4
5
5
- CI only builds, doesn't lint/check-types ([.github/workflows/docusaurus-build.yml](.github/workflows/docusaurus-build.yml:29)). Run "pnpm run lint" and "pnpm run check-types" locally before pushing.
6
-
-PostHog analytics silently skips if POSTHOG_API_KEY missing. Check[.env](.env) exists with key from [.env.example](.env.example).
6
+
-No environment variables are required by default. Use[.env.example](.env.example) only when debugging local-only settings.
7
7
- No test framework configured. Scripts exist in package.json but no test files or jest/vitest config present.
8
8
- Docusaurus dev server at localhost:3000. Hot reload may fail for theme swizzled components; restart if changes don't appear.
9
9
- onBrokenLinks set to "warn" ([docusaurus.config.ts](docusaurus.config.ts:40)) - broken links won't fail build but check console warnings.
10
-
- Node version mismatch (engines >=18, CI uses 20) can cause subtle differences. Use Node 20 locally.
10
+
- Node version mismatch (engines >=18, CI uses 20) can cause subtle differences. Use Node 20 locally.
Copy file name to clipboardExpand all lines: AGENTS.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This file provides guidance to agents when working with code in this repository.
4
4
5
5
Non-obvious, project-specific rules:
6
6
7
-
- Start/build preload dotenv; analytics plugin is enabled only when POSTHOG_API_KEY is set. Use .env based on [.env.example](.env.example). CI injects it in [.github/workflows/docusaurus-build.yml](.github/workflows/docusaurus-build.yml). See [package.json](package.json) and [docusaurus.config.ts](docusaurus.config.ts).
7
+
- Start/build preload dotenv. No environment variables are required by default; use [.env.example](.env.example) only when adding local-only settings. See [package.json](package.json) and [docusaurus.config.ts](docusaurus.config.ts).
8
8
- Use Node 20 locally to match CI; engines allow >=18 but CI runs 20.
9
9
- Linting targets only /src; docs content is not linted. Use "pnpm run lint:unused" to enforce unused import removal. Type checking uses "tsc" only (no emit); [tsconfig.json](tsconfig.json) is editor-focused.
10
10
- When moving/renaming docs, you must add an explicit redirect in [docusaurus.config.ts](docusaurus.config.ts) under plugin-client-redirects. This is required by [.roorules](.roorules).
- Navigation/footer links are centralized in [src/constants.ts](src/constants.ts) and consumed by [docusaurus.config.ts](docusaurus.config.ts). Update constants rather than hardcoding URLs.
17
17
- Legacy [Rakefile](Rakefile) is unrelated (Jekyll). Do not use it; all builds run through Docusaurus scripts.
18
18
- For structural/formatting research, use Context7 MCP (ID "/facebook/docusaurus") via [.roo/mcp.json](.roo/mcp.json); see [.roorules](.roorules).
19
-
- CI runs build and check-types (no lint). Run lint locally to catch issues CI won't.
19
+
- CI runs build and check-types (no lint). Run lint locally to catch issues CI won't.
Copy file name to clipboardExpand all lines: docs/faq.md
+4-7Lines changed: 4 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ This page answers some common questions about Roo Code.
22
22
23
23
### What is Roo Code?
24
24
25
-
Roo Code is an AI-powered suite of coding products designed to take full advantage of the most advanced large-language models.
25
+
Roo Code is an open-source AI coding agent for VS Code designed to take full advantage of advanced large-language models.
26
26
27
27
### How does Roo Code work?
28
28
@@ -33,7 +33,7 @@ Roo Code uses large language models (LLMs) to understand your requests and trans
33
33
- Perform web browsing (if enabled)
34
34
- Use external tools via the Model Context Protocol (MCP)
35
35
36
-
You interact with Roo Code through either a chat interface (in the Extension) or through different channels (in the Cloud).
36
+
You interact with Roo Code through a chat interface in the extension.
37
37
38
38
### What can Roo Code do?
39
39
@@ -50,10 +50,9 @@ Roo Code can help with a variety of coding tasks, including:
50
50
51
51
### Is Roo Code free to use?
52
52
53
-
The Roo Code Extension is free and [open-source](https://github.com/RooCodeInc/Roo-Code/).
54
-
The Roo Code Cloud platform is also free, but some functionality is paid.
53
+
The Roo Code extension is free and [open-source](https://github.com/RooCodeInc/Roo-Code/).
55
54
56
-
In both cases, Roo Code relies on external LLM inference providers (like [Anthropic](providers/anthropic), [OpenAI](providers/openai), [OpenRouter](providers/openrouter), [Requesty](providers/requesty), etc.) for its AI capabilities. We also offer [Roo Code Router](/roo-code-router/overview) as an alternative.
55
+
Roo Code relies on external LLM inference providers (like [Anthropic](providers/anthropic), [OpenAI](providers/openai), [OpenRouter](providers/openrouter), [Requesty](providers/requesty), etc.) for its AI capabilities.
57
56
These providers typically charge for API usage based on the number of tokens processed. You will need to create an account and obtain an API key from your chosen provider. Learn more [about providers and how to set them up](/providers/) for details.
58
57
59
58
### What are the risks of using Roo Code?
@@ -80,8 +79,6 @@ See the [full list here](/providers/).
80
79
81
80
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.
82
81
83
-
If you use the [Roo Code Router](/roo-code-router/overview), you don't need an API key.
84
-
85
82
### Can I use Roo Code with local models?
86
83
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.
0 commit comments