Skip to content

Commit a937f3d

Browse files
johnxiejohnxie
authored
docs: add roo code tutorial and refresh catalog (#63)
1 parent a49ce31 commit a937f3d

11 files changed

Lines changed: 381 additions & 8 deletions

‎README.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
[![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
1616
[![GitHub stars](https://img.shields.io/github/stars/johnxie/awesome-code-docs?style=social)](https://github.com/johnxie/awesome-code-docs)
17-
[![Tutorials](https://img.shields.io/badge/tutorials-93-brightgreen.svg)](#-tutorial-catalog)
17+
[![Tutorials](https://img.shields.io/badge/tutorials-94-brightgreen.svg)](#-tutorial-catalog)
1818
[![Content Hours](https://img.shields.io/badge/content-1100%2B%20hours-orange.svg)](#-tutorial-catalog)
1919
[![Last Updated](https://img.shields.io/github/last-commit/johnxie/awesome-code-docs?label=updated)](https://github.com/johnxie/awesome-code-docs/commits/main)
2020

@@ -62,7 +62,7 @@ Each chapter includes **Mermaid architecture diagrams**, **annotated code exampl
6262
```
6363
╔════════════════════════════════════════════════════════════╗
6464
║ 🤖 AI & AGENTS │ 🔧 DEV TOOLS │ 🗄️ DATA │ 🎤 SPEECH ║
65-
║ 57+ tutorials │ 20 tutorials │ 14 tutorials │ 3 tutorials ║
65+
║ 57+ tutorials │ 21 tutorials │ 14 tutorials │ 3 tutorials ║
6666
╚════════════════════════════════════════════════════════════╝
6767
```
6868

@@ -152,7 +152,8 @@ AI coding assistants, build systems, and dev infrastructure.
152152
| Tutorial | Stars | Stack | What You'll Learn |
153153
|:---------|:-----:|:------|:------------------|
154154
| **[Continue](tutorials/continue-tutorial/)** | 22K+ | TypeScript | Open-source AI coding assistant |
155-
| **[Cline](tutorials/cline-tutorial/)** | 57K+ | TypeScript/VS Code | Agentic coding with terminal, browser, MCP tools |
155+
| **[Cline](tutorials/cline-tutorial/)** | 58K+ | TypeScript/VS Code | Agentic coding with terminal, browser, MCP tools |
156+
| **[Roo Code](tutorials/roo-code-tutorial/)** | 22K+ | TypeScript/VS Code | Multi-mode coding agents with checkpoints and MCP |
156157
| **[bolt.diy](tutorials/bolt-diy-tutorial/)** | 19K+ | TypeScript/Remix | Open-source Bolt-style AI app builder |
157158
| **[OpenHands](tutorials/openhands-tutorial/)** | 67K+ | Python | AI software engineering agent |
158159
| **[Aider](tutorials/aider-tutorial/)** | 25K+ | Python | AI pair programming in terminal |
@@ -336,8 +337,8 @@ OpenAI Python SDK ──→ tiktoken ──→ OpenAI Whisper ──→ Realtime
336337
╔══════════════════════════════════════════════════════════╗
337338
║ COLLECTION OVERVIEW ║
338339
╠══════════════════════════════════════════════════════════╣
339-
║ 📦 Total Tutorials 93 ║
340-
║ 📝 Total Chapters 776+ ║
340+
║ 📦 Total Tutorials 94 ║
341+
║ 📝 Total Chapters 784+ ║
341342
║ 📏 Lines of Content 520,000+ ║
342343
║ ⏱️ Estimated Hours 1,100+ ║
343344
║ 🏗️ Architecture Diagrams 550+ ║
@@ -351,7 +352,7 @@ OpenAI Python SDK ──→ tiktoken ──→ OpenAI Whisper ──→ Realtime
351352
| 🧠 LLM Frameworks & RAG | 12 | Complete |
352353
| 🖥️ LLM Infrastructure | 9 | Complete |
353354
| 💬 Chat & AI Apps | 13 | Complete |
354-
| 🔧 Developer Tools | 19 | Complete |
355+
| 🔧 Developer Tools | 20 | Complete |
355356
| 🗄️ Data & Analytics | 14 | Complete |
356357
| ⚙️ Systems & Infra | 6 | Complete |
357358
| 🎤 Speech & Multimodal AI | 3 | Complete |

‎tutorials/roo-code-tutorial/01-getting-started.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: default
3+
title: "Chapter 1: Getting Started"
4+
nav_order: 1
5+
parent: Roo Code Tutorial
6+
---
7+
8+
# Chapter 1: Getting Started
9+
10+
This chapter gets Roo Code installed and validated in an editor development loop.
11+
12+
## Setup Path
13+
14+
1. install Roo Code from supported marketplace/install method
15+
2. configure provider credentials/profile
16+
3. open a sandbox repository
17+
4. run a small bounded task with review enabled
18+
19+
## First Validation Task
20+
21+
Use a low-risk task combining analysis + edit + verification:
22+
23+
- summarize module structure
24+
- apply a tiny refactor
25+
- run lint or one test command
26+
27+
This confirms end-to-end toolchain behavior.
28+
29+
## Safety Baseline
30+
31+
Keep approvals active for command and edit operations while calibrating your profile and mode defaults.
32+
33+
## Summary
34+
35+
You now have a functioning Roo Code setup and baseline for deeper mode-driven workflows.
36+
37+
Next: [Chapter 2: Modes and Task Design](02-modes-and-task-design.md)

‎tutorials/roo-code-tutorial/02-modes-and-task-design.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
layout: default
3+
title: "Chapter 2: Modes and Task Design"
4+
nav_order: 2
5+
parent: Roo Code Tutorial
6+
---
7+
8+
# Chapter 2: Modes and Task Design
9+
10+
Roo Code’s mode system is a core differentiator for workflow control.
11+
12+
## Mode Semantics
13+
14+
- **Code**: direct implementation and edits
15+
- **Architect**: planning, system design, migration maps
16+
- **Ask**: fast explanations and scoped Q&A
17+
- **Debug**: failure diagnosis and remediation loops
18+
- **Custom**: team-specific specialist behavior
19+
20+
## Mode Selection Heuristic
21+
22+
| Task Type | Recommended Mode |
23+
|:----------|:-----------------|
24+
| implement feature | Code |
25+
| design refactor plan | Architect |
26+
| explain unfamiliar subsystem | Ask |
27+
| reproduce and fix failures | Debug |
28+
| repeated domain workflow | Custom |
29+
30+
## Prompt Design by Mode
31+
32+
Define inputs and acceptance criteria differently per mode so the model does not overreach.
33+
34+
## Summary
35+
36+
You can now choose and apply modes deliberately to improve output quality and reduce wasted cycles.
37+
38+
Next: [Chapter 3: File and Command Operations](03-file-and-command-operations.md)

‎tutorials/roo-code-tutorial/03-file-and-command-operations.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
layout: default
3+
title: "Chapter 3: File and Command Operations"
4+
nav_order: 3
5+
parent: Roo Code Tutorial
6+
---
7+
8+
# Chapter 3: File and Command Operations
9+
10+
Effective Roo workflows combine code edits with runtime verification.
11+
12+
## Operation Loop
13+
14+
1. propose targeted file changes
15+
2. review diffs
16+
3. approve and apply
17+
4. execute validation commands
18+
5. iterate based on output
19+
20+
## Safety Controls
21+
22+
- keep destructive shell actions approval-gated
23+
- scope edits to explicit file sets
24+
- require validation command before task completion
25+
26+
## Reliability Practices
27+
28+
| Practice | Benefit |
29+
|:---------|:--------|
30+
| deterministic test/lint command | consistent verification |
31+
| structured command logs | easier debugging/audit |
32+
| bounded retry policy | avoids runaway loops |
33+
34+
## Summary
35+
36+
You now have a practical edit-and-verify loop for reliable Roo Code operation.
37+
38+
Next: [Chapter 4: Context and Indexing](04-context-and-indexing.md)

‎tutorials/roo-code-tutorial/04-context-and-indexing.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
layout: default
3+
title: "Chapter 4: Context and Indexing"
4+
nav_order: 4
5+
parent: Roo Code Tutorial
6+
---
7+
8+
# Chapter 4: Context and Indexing
9+
10+
Large-codebase performance depends on disciplined context management.
11+
12+
## Context Strategy
13+
14+
- include only task-relevant files and traces
15+
- use indexing/search features for targeted retrieval
16+
- avoid context flooding with entire repositories
17+
18+
## Indexing Benefits
19+
20+
Good indexing enables faster retrieval of symbols, references, and related files, which improves agent grounding and reduces hallucinated edits.
21+
22+
## Context Governance
23+
24+
| Rule | Purpose |
25+
|:-----|:--------|
26+
| explicit include set | lower token cost |
27+
| relevance-first retrieval | higher answer precision |
28+
| stale context refresh | prevent outdated assumptions |
29+
30+
## Summary
31+
32+
You can now manage context as a resource with quality, latency, and cost impact.
33+
34+
Next: [Chapter 5: Checkpoints and Recovery](05-checkpoints-and-recovery.md)

‎tutorials/roo-code-tutorial/05-checkpoints-and-recovery.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
layout: default
3+
title: "Chapter 5: Checkpoints and Recovery"
4+
nav_order: 5
5+
parent: Roo Code Tutorial
6+
---
7+
8+
# Chapter 5: Checkpoints and Recovery
9+
10+
Checkpoint workflows make autonomous experimentation safer.
11+
12+
## Checkpoint Pattern
13+
14+
- snapshot workspace before risky edits
15+
- compare output against checkpoint state
16+
- restore quickly when changes regress behavior
17+
18+
## Use Cases
19+
20+
- trying alternative implementation strategies
21+
- testing aggressive refactors
22+
- recovering from prompt overreach
23+
24+
## Recovery Rules
25+
26+
| Rule | Why |
27+
|:-----|:----|
28+
| checkpoint before multi-file edits | fast rollback |
29+
| annotate checkpoints with intent | easier comparison |
30+
| restore with validation rerun | confirm clean recovery |
31+
32+
## Summary
33+
34+
You now have a controlled rollback strategy for agent-assisted development.
35+
36+
Next: [Chapter 6: MCP and Tool Extensions](06-mcp-and-tool-extensions.md)

‎tutorials/roo-code-tutorial/06-mcp-and-tool-extensions.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: default
3+
title: "Chapter 6: MCP and Tool Extensions"
4+
nav_order: 6
5+
parent: Roo Code Tutorial
6+
---
7+
8+
# Chapter 6: MCP and Tool Extensions
9+
10+
MCP tool integration extends Roo Code into domain-specific workflows.
11+
12+
## MCP Extension Workflow
13+
14+
1. connect or register an MCP server
15+
2. inspect tool contracts
16+
3. validate call/response behavior
17+
4. gate mutating tools via explicit approvals
18+
19+
## Tool Contract Guidelines
20+
21+
- strict schema validation
22+
- deterministic error responses
23+
- side-effect classification
24+
- timeout and retry limits
25+
26+
## Common High-Value Tools
27+
28+
- issue tracker integration
29+
- cloud infra operations
30+
- internal docs/knowledge retrieval
31+
- deployment/environment status queries
32+
33+
## Summary
34+
35+
You can now design MCP integrations that are powerful but still governable.
36+
37+
Next: [Chapter 7: Profiles and Team Standards](07-profiles-and-team-standards.md)

‎tutorials/roo-code-tutorial/07-profiles-and-team-standards.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
layout: default
3+
title: "Chapter 7: Profiles and Team Standards"
4+
nav_order: 7
5+
parent: Roo Code Tutorial
6+
---
7+
8+
# Chapter 7: Profiles and Team Standards
9+
10+
Team adoption depends on shared profiles and operating conventions.
11+
12+
## Team Profile Components
13+
14+
- default model/provider strategy
15+
- mode usage rules by task type
16+
- command and tool allowlists
17+
- coding and review standards
18+
19+
## Standardization Benefits
20+
21+
| Standard | Outcome |
22+
|:---------|:--------|
23+
| shared prompt patterns | more consistent results |
24+
| common validation commands | easier CI alignment |
25+
| policy versioning | safer rollout and rollback |
26+
27+
## Rollout Pattern
28+
29+
1. start with a pilot profile
30+
2. measure quality/cost outcomes
31+
3. refine and publish team baseline
32+
4. expand to more repositories
33+
34+
## Summary
35+
36+
You can now deploy Roo Code with predictable team-wide behavior and quality controls.
37+
38+
Next: [Chapter 8: Enterprise Operations](08-enterprise-operations.md)

‎tutorials/roo-code-tutorial/08-enterprise-operations.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
layout: default
3+
title: "Chapter 8: Enterprise Operations"
4+
nav_order: 8
5+
parent: Roo Code Tutorial
6+
---
7+
8+
# Chapter 8: Enterprise Operations
9+
10+
This chapter covers production governance for Roo Code at organizational scale.
11+
12+
## Enterprise Control Areas
13+
14+
- identity and access policy
15+
- centralized model/provider governance
16+
- immutable audit and usage telemetry
17+
- network and secret management controls
18+
19+
## Observability Baseline
20+
21+
Track:
22+
23+
- task success/failure rates
24+
- command and tool error classes
25+
- model latency and token cost by mode
26+
- policy-denied action trends
27+
28+
## Incident Readiness
29+
30+
- keep emergency disable controls for risky tools
31+
- maintain rollback paths for policy/profile changes
32+
- run periodic drills for provider outages
33+
34+
## Final Summary
35+
36+
You now have end-to-end guidance for operating Roo Code from individual productivity to enterprise-grade governance.
37+
38+
Related:
39+
- [Cline Tutorial](../cline-tutorial/)
40+
- [OpenHands Tutorial](../openhands-tutorial/)
41+
- [MCP Servers Tutorial](../mcp-servers-tutorial/)

0 commit comments

Comments
 (0)