Skip to content

Commit 600b1db

Browse files
Refactor(docs): Relocate developer and prerelease installation guides (#199)
- Moves "Local Setup & Development" instructions from the main installation guide to a new dedicated page: `docs/advanced-usage/local-development-setup.mdx`. - Creates a new page for "Prerelease Build" information (covering Roo Code Nightly) at `docs/advanced-usage/prerelease-build.mdx`. - Updates `docs/getting-started/installing.mdx` to remove the detailed sections and instead link to these new, more appropriately placed advanced usage guides. - Adjusts `sidebars.ts` to correctly list the new pages under the "Advanced Usage" category. - Adds new image `static/img/installing/installing-5.png` for the prerelease build documentation. This restructuring improves the organization of the installation documentation by separating standard installation procedures from more advanced topics like local development and using prerelease software.
1 parent ade6dce commit 600b1db

File tree

5 files changed

+85
-14
lines changed

5 files changed

+85
-14
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
sidebar_label: Local Development Setup
3+
---
4+
5+
## Local Setup & Development
6+
7+
:::note Developer Information Only
8+
This section is for developers contributing to Roo Code or those who wish to build and run the extension from source.
9+
:::
10+
11+
To set up Roo Code for local development:
12+
13+
1. **Clone the repository:**
14+
```bash
15+
git clone https://github.com/RooCodeInc/Roo-Code.git
16+
cd Roo-Code
17+
```
18+
19+
2. **Install dependencies:**
20+
Roo Code uses `pnpm` for package management.
21+
```bash
22+
pnpm install
23+
```
24+
25+
3. **Run the extension for development:**
26+
You have two primary methods:
27+
28+
* **Directly in VS Code (Recommended for active development):**
29+
* Open the cloned `Roo-Code` folder in VS Code.
30+
* Press `F5` (or select **Run****Start Debugging** from the menu). This opens a new VS Code window (Extension Development Host) with Roo Code running.
31+
* Changes to the webview code (under `webview-ui/`) will often update live.
32+
* Changes to the core extension code (under `src/`) typically require restarting the Extension Development Host window.
33+
34+
* **Building and Installing a VSIX package:**
35+
This method is useful for testing the packaged extension or distributing development builds.
36+
1. Build the VSIX file:
37+
```bash
38+
pnpm build
39+
```
40+
A `.vsix` file (e.g., `roo-cline-<version>.vsix`) will be created in the `bin/` directory.
41+
42+
2. Install the VSIX in VS Code:
43+
* **Using the command line:**
44+
```bash
45+
code --install-extension bin/roo-cline-<version>.vsix
46+
```
47+
(Replace `<version>` with the actual version number in the filename).
48+
* **Using the VS Code interface:**
49+
* Open the Extensions view (`Ctrl+Shift+X` or `Cmd+Shift+X`).
50+
* Click the "..." (More Actions) menu in the Extensions view sidebar.
51+
* Select "Install from VSIX..."
52+
* Browse to and select the generated `.vsix` file from the `bin/` directory.
53+
54+
<img src="/img/installing/installing-2.png" alt="VS Code's Install from VSIX dialog" width="600" />
55+
*Installing a development VSIX using VS Code's "Install from VSIX..." dialog.*
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
sidebar_label: Prerelease Build
3+
---
4+
5+
# Prerelease Build
6+
7+
For users who want the latest features and updates, Roo Code offers prerelease builds. The primary prerelease build is **Roo Code Nightly**, which is automatically published whenever changes are merged into our main development branch.
8+
9+
**Note:** As prerelease software, these builds may occasionally include experimental features or bugs. They are best suited for users comfortable with testing cutting-edge software.
10+
11+
To install a prerelease build like Roo Code Nightly:
12+
13+
1. Open VS Code.
14+
2. Access Extensions: Click the Extensions icon in the Activity Bar or press `Ctrl+Shift+X` (Windows/Linux) or `Cmd+Shift+X` (macOS).
15+
3. Search for "Roo Code Nightly" (or the specific prerelease build name).
16+
4. Select the prerelease extension (e.g., "Roo Code Nightly" by RooVeterinaryInc) and click **Install**.
17+
* If you have the stable version of Roo Code installed, the Marketplace might show an option to "Switch to Pre-Release Version" for the Roo Code extension itself, or you might find "Roo Code Nightly" as a separate listing.
18+
5. Reload VS Code if prompted.
19+
20+
<img src="/img/installing/installing-5.png" alt="Roo Code prerelease (Nightly) extension in VS Code Marketplace" width="400" />
21+
*Roo Code Nightly (prerelease build) in the VS Code Marketplace.*
22+
23+
You can have both the stable version of Roo Code and a prerelease build (like Roo Code Nightly) installed simultaneously. However, it's generally recommended to enable only one at a time in your VS Code workspace to avoid potential conflicts or unexpected behavior.

docs/getting-started/installing.mdx

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ For VS Code-compatible editors without Marketplace access (like VSCodium and Win
5050

5151
<img src="/img/installing/installing-3.png" alt="Open VSX Registry with Roo Code extension ready to install" width="400" />
5252
*Open VSX Registry with Roo Code extension ready to install*
53+
## Prerelease Build
54+
55+
For information on installing a prerelease build, such as Roo Code Nightly, please see the [Prerelease Build](/advanced-usage/prerelease-build) guide in the Advanced Usage section.
5356
## Manual Installation from VSIX
5457

5558
If you prefer to download and install the VSIX file directly:
@@ -68,21 +71,9 @@ If you prefer to download and install the VSIX file directly:
6871
<img src="/img/installing/installing-2.png" alt="VS Code's Install from VSIX dialog" width="400" />
6972
*Installing Roo Code using VS Code's "Install from VSIX" dialog*
7073

71-
## Development Builds
72-
73-
:::note Developer Information Only
74-
This section is intended only for developers contributing to Roo Code.
75-
:::
76-
77-
If you're building Roo Code from source:
74+
## Local Setup & Development
7875

79-
1. Run `npm run build` in the project directory
80-
2. Find the generated VSIX file in the `bin/` directory
81-
3. In VS Code, open Extensions view and select "Install from VSIX..." from the "..." menu
82-
4. Browse to and select your generated `.vsix` file
83-
84-
<img src="/img/installing/installing-2.png" alt="VS Code's Install from VSIX dialog" width="400" />
85-
*Installing a development build using VS Code's "Install from VSIX" dialog*
76+
For instructions on setting up Roo Code for local development, building from source, or contributing, please see the [Local Development Setup](/advanced-usage/local-development-setup) guide in the Advanced Usage section.
8677

8778
## Troubleshooting
8879

sidebars.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,8 @@ const sidebars: SidebarsConfig = {
9797
'advanced-usage/context-poisoning',
9898
'advanced-usage/large-projects',
9999
'advanced-usage/local-models',
100+
'advanced-usage/local-development-setup',
101+
'advanced-usage/prerelease-build',
100102
'advanced-usage/prompt-engineering',
101103
'advanced-usage/prompt-structure',
102104
'advanced-usage/rate-limits-costs',
24.7 KB
Loading

0 commit comments

Comments
 (0)