Skip to content

Commit f9c0445

Browse files
committed
docs: enhance 'Your First Task' guide with clearer instructions and new images
1 parent b8e2cb6 commit f9c0445

File tree

5 files changed

+41
-18
lines changed

5 files changed

+41
-18
lines changed

docs/getting-started/your-first-task.md

Lines changed: 41 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,64 @@ sidebar_label: Your First Task
44

55
# Starting Your First Task with Roo Code
66

7-
Now that you've [configured your AI provider and model](./connecting-api-provider), you're ready to start using Roo Code! This guide will walk you through your first interaction.
7+
Now that you've [configured your AI provider and model](./connecting-api-provider), you're ready to start using Roo Code! This guide walks you through your first interaction.
88

99
## Step 1: Open the Roo Code Panel
1010

11-
If the Roo Code panel isn't already visible, click the Roo Code icon (<Codicon name="rocket" />) in the VS Code Activity Bar (the vertical bar on the side of the window). This will open the Roo Code chat interface. If you don't see the icon, make sure the extension is installed and enabled.
11+
Click the Roo Code icon (<Codicon name="rocket" />) in the VS Code Activity Bar (vertical bar on the side of the window) to open the chat interface. If you don't see the icon, verify the extension is installed and enabled.
12+
13+
<img src="/img/your-first-task/your-first-task.png" alt="Roo Code icon in VS Code Activity Bar" width="800" />
14+
15+
*The Roo Code icon in the Activity Bar opens the chat interface.*
1216

1317
## Step 2: Type Your Task
1418

15-
In the Roo Code chat box (at the bottom of the panel), type a description of what you want Roo Code to do. Be clear and concise. Here are some examples of good initial tasks:
19+
Type a clear, concise description of what you want Roo Code to do in the chat box at the bottom of the panel. Examples of effective tasks:
20+
21+
* "Create a file named `hello.txt` containing 'Hello, world!'."
22+
* "Write a Python function that adds two numbers."
23+
* "Create an HTML file for a simple website with the title 'Roo test'"
1624

17-
* "Create a file named `hello.txt` containing 'Hello, world!'."
18-
* "Write a Python function that adds two numbers."
19-
* "Create an html file for a simple website with the title 'Roo test'"
25+
No special commands or syntax needed—just use plain English.
2026

21-
You don't need to use any special commands or syntax at this point. Just write your request in plain English.
27+
<img src="/img/your-first-task/your-first-task-6.png" alt="Typing a task in the Roo Code chat interface" width="500" />
28+
*Enter your task in natural language - no special syntax required.*
2229

2330
## Step 3: Send Your Task
2431

25-
Press Enter, or click the Send icon (<Codicon name="send" />) to the right of the input box.
32+
Press Enter or click the Send icon (<Codicon name="send" />) to the right of the input box.
2633

2734
## Step 4: Review and Approve Actions
2835

29-
Roo Code will analyze your request and propose a series of actions. These actions might include:
36+
Roo Code analyzes your request and proposes specific actions. These may include:
3037

31-
* **Reading files:** Roo Code will show you the contents of files it wants to read.
32-
* **Writing to files:** Roo Code will show you a diff (a visual representation of the changes) of any proposed file modifications. You'll see added lines in green and removed lines in red.
33-
* **Executing commands:** Roo Code will show you the exact command it wants to run in your terminal.
34-
* **Using the Browser:** Roo Code will show you the action it's going to perform (click, type, etc)
35-
* **Asking a question:** If Roo Code is not sure on how to proceed, it will ask you follow-up questions.
38+
* **Reading files:** Shows file contents it needs to access
39+
* **Writing to files:** Displays a diff with proposed changes (added lines in green, removed in red)
40+
* **Executing commands:** Shows the exact command to run in your terminal
41+
* **Using the Browser:** Outlines browser actions (click, type, etc.)
42+
* **Asking questions:** Requests clarification when needed to proceed
3643

37-
**You will have the opportunity to approve or reject each action.** Roo Code will not perform any action without your explicit permission (unless you've enabled auto-approval in the settings).
44+
<img src="/img/your-first-task/your-first-task-7.png" alt="Reviewing a proposed file creation action" width="800" />
45+
*Roo Code shows exactly what action it wants to perform and waits for your approval.*
3846

39-
* **Approve:** If you're happy with the proposed action, click the "Approve" button (or similar).
40-
* **Reject:** If you don't want Roo Code to perform the action, click the "Reject" button. You can provide feedback to help Roo Code understand why you rejected the action.
47+
**Each action requires your explicit approval** (unless auto-approval is enabled):
48+
49+
* **Approve:** Click the "Approve" button to execute the proposed action
50+
* **Reject:** Click the "Reject" button and provide feedback if needed
4151

4252
## Step 5: Iterate
4353

44-
Roo Code works iteratively. After each action, it will wait for your feedback and then propose the next step. Continue reviewing and approving (or rejecting) actions until the task is complete.
54+
Roo Code works iteratively. After each action, it waits for your feedback before proposing the next step. Continue this review-approve cycle until your task is complete.
55+
56+
<img src="/img/your-first-task/your-first-task-8.png" alt="Final result of a completed task showing the iteration process" width="500" />
57+
*After completing the task, Roo Code shows the final result and awaits your next instruction.*
58+
59+
## Conclusion
60+
61+
You've now completed your first task with Roo Code! Through this process, you've learned:
62+
63+
* How to interact with Roo Code using natural language
64+
* The approval-based workflow that keeps you in control
65+
* The iterative approach Roo Code uses to solve problems step-by-step
66+
67+
This iterative, approval-based workflow is at the core of how Roo Code works—letting AI handle the tedious parts of coding while you maintain complete oversight. Now that you understand the basics, you're ready to tackle more complex tasks, explore different [modes](../basic-usage/modes) for specialized workflows, or try the [auto-approval feature](../advanced-usage/auto-approving-actions) to speed up repetitive tasks.
172 KB
Loading
316 KB
Loading
201 KB
Loading
135 KB
Loading

0 commit comments

Comments
 (0)