Skip to content

Commit b3793e5

Browse files
committed
docs: add comprehensive repository analysis document
- Added detailed analysis of all three git repositories in the workspace - Covers Roo-Code (VS Code extension), Roo-Code-Cloud (infrastructure), and Roo-Code-Docs (documentation) - Includes purpose, technology stack, key features, and repository relationships - Provides comprehensive overview for developers and stakeholders
1 parent 8e4c0ae commit b3793e5

File tree

1 file changed

+167
-0
lines changed

1 file changed

+167
-0
lines changed

repository-analysis.md

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
# Git Repository Analysis
2+
3+
This document provides a comprehensive overview of the git repositories found in the current working directory, explaining the purpose and contents of each repository.
4+
5+
## Overview
6+
7+
There are **3 main git repositories** in the current directory:
8+
9+
1. [`Roo-Code/`](Roo-Code/) - The main VS Code extension
10+
2. [`Roo-Code-Cloud/`](Roo-Code-Cloud/) - Cloud infrastructure and services
11+
3. [`Roo-Code-Docs/`](Roo-Code-Docs/) - Documentation website
12+
13+
---
14+
15+
## 1. Roo-Code Repository
16+
17+
**Location:** [`Roo-Code/`](Roo-Code/)
18+
**Type:** VS Code Extension
19+
**Technology Stack:** TypeScript, Node.js, VS Code Extension API
20+
**Package Manager:** pnpm
21+
22+
### Purpose
23+
This is the main repository for **Roo Code**, an AI-powered autonomous coding agent that runs as a VS Code extension. It serves as an intelligent coding assistant that can communicate in natural language, read/write files, run terminal commands, and automate browser actions.
24+
25+
### Key Features
26+
- **Multiple AI Provider Support**: Integrates with OpenAI-compatible APIs and custom models
27+
- **Multiple Modes**: Code, Architect, Ask, Debug, and Custom Modes for specialized tasks
28+
- **Smart Tools**: File operations, terminal commands, web browser control
29+
- **MCP Integration**: Model Context Protocol for extending capabilities
30+
- **Customization**: Custom instructions, modes, local models, and auto-approval settings
31+
32+
### Repository Structure
33+
- **`src/`**: Main extension source code including [`extension.ts`](Roo-Code/src/extension.ts) (entry point)
34+
- **`webview-ui/`**: User interface components for the VS Code webview
35+
- **`packages/`**: Shared packages and utilities
36+
- **`apps/`**: Application components
37+
- **`locales/`**: Internationalization files (supports 15+ languages)
38+
- **`scripts/`**: Build and development scripts
39+
40+
### Development
41+
- **Node.js Version**: 20.19.2
42+
- **Build System**: Turbo monorepo with TypeScript
43+
- **Testing**: Vitest framework
44+
- **Distribution**: Published to VS Code Marketplace as VSIX packages
45+
46+
---
47+
48+
## 2. Roo-Code-Cloud Repository
49+
50+
**Location:** [`Roo-Code-Cloud/`](Roo-Code-Cloud/)
51+
**Type:** Cloud Infrastructure Monorepo
52+
**Technology Stack:** TypeScript, Node.js, Docker, PostgreSQL, ClickHouse, Redis
53+
**Package Manager:** pnpm
54+
**Deployment:** Fly.io
55+
56+
### Purpose
57+
This repository contains the cloud infrastructure and backend services that power Roo Code's cloud features. It's a comprehensive monorepo that includes multiple microservices, APIs, dashboards, and deployment tools.
58+
59+
### Key Components
60+
61+
#### Applications (`apps/`)
62+
- **`web/`**: Main web application and dashboard
63+
- **`roomote-api/`**: Core API service for Roomote (remote execution service)
64+
- **`roomote-controller/`**: Service controller and orchestration
65+
- **`roomote-dashboard/`**: Administrative dashboard
66+
- **`roomote-worker/`**: Background job processing and AI agent execution
67+
- **`roomote-cli/`**: Command-line interface for management
68+
- **`roomote-deployer/`**: Deployment automation tools
69+
- **`provider-proxy/`**: API proxy for AI providers
70+
- **`extension-bridge/`**: Bridge service between VS Code extension and cloud
71+
- **`dev/`**: Development environment setup
72+
73+
#### Infrastructure
74+
- **Database Stack**: PostgreSQL (primary data), ClickHouse (analytics), Redis (caching)
75+
- **Containerization**: Docker Compose for local development
76+
- **Deployment**: Fly.io with automated CI/CD
77+
- **Security**: Encrypted environment variables using dotenvx
78+
79+
### Development Environment
80+
- **Node.js Version**: 22.x
81+
- **Database Setup**: Automated with `pnpm db:up`
82+
- **Local Development**: `pnpm dev` starts all services
83+
- **Environment Management**: Encrypted `.env` files for different environments
84+
85+
### Key Features
86+
- **Multi-tenant Architecture**: Supports multiple organizations and users
87+
- **Real-time Communication**: WebSocket connections for live updates
88+
- **Analytics**: ClickHouse-powered analytics and monitoring
89+
- **Scalable Deployment**: Microservices architecture on Fly.io
90+
- **Development Tools**: Comprehensive CLI and deployment automation
91+
92+
---
93+
94+
## 3. Roo-Code-Docs Repository
95+
96+
**Location:** [`Roo-Code-Docs/`](Roo-Code-Docs/)
97+
**Type:** Documentation Website
98+
**Technology Stack:** Docusaurus, React, TypeScript
99+
**Package Manager:** npm
100+
**Deployment:** Static site hosting
101+
102+
### Purpose
103+
This repository contains the official documentation website for Roo Code, built with Docusaurus. It serves as the comprehensive user guide and developer documentation.
104+
105+
### Website URL
106+
**Live Site:** [https://docs.roocode.com](https://docs.roocode.com)
107+
108+
### Content Structure
109+
- **`docs/`**: Main documentation content
110+
- **`getting-started/`**: Installation and setup guides
111+
- **`basic-usage/`**: Core functionality documentation
112+
- **`advanced-usage/`**: Advanced features and customization
113+
- **`features/`**: Detailed feature explanations
114+
- **`providers/`**: AI provider integration guides
115+
- **`roo-code-cloud/`**: Cloud service documentation
116+
- **`update-notes/`**: Release notes and changelogs
117+
118+
### Key Features
119+
- **Modern Documentation**: Built with Docusaurus v3
120+
- **Search Functionality**: Local search with `@easyops-cn/docusaurus-search-local`
121+
- **Analytics**: PostHog integration for usage tracking
122+
- **Responsive Design**: Mobile-friendly documentation
123+
- **Code Highlighting**: Syntax highlighting for multiple languages
124+
125+
### Development
126+
- **Node.js Version**: 18+
127+
- **Local Development**: `npm start` for live preview
128+
- **Build**: `npm run build` for production
129+
- **Deployment**: Static site generation
130+
131+
---
132+
133+
## Repository Relationships
134+
135+
```mermaid
136+
graph TB
137+
A[Roo-Code Extension] --> B[Roo-Code-Cloud Services]
138+
A --> C[Roo-Code-Docs Website]
139+
B --> D[AI Providers]
140+
B --> E[User Data & Analytics]
141+
C --> F[Users & Developers]
142+
143+
subgraph "Local Development"
144+
A
145+
end
146+
147+
subgraph "Cloud Infrastructure"
148+
B
149+
D
150+
E
151+
end
152+
153+
subgraph "Documentation"
154+
C
155+
F
156+
end
157+
```
158+
159+
## Summary
160+
161+
These three repositories form a complete ecosystem:
162+
163+
1. **Roo-Code**: The core VS Code extension that users interact with directly
164+
2. **Roo-Code-Cloud**: The backend infrastructure that powers cloud features, analytics, and multi-user capabilities
165+
3. **Roo-Code-Docs**: The documentation that helps users understand and effectively use the platform
166+
167+
Together, they provide a comprehensive AI-powered coding assistant platform with local and cloud capabilities, extensive documentation, and enterprise-grade infrastructure.

0 commit comments

Comments
 (0)