Skip to content

Commit 3113327

Browse files
committed
Update Boomerang Tasks documentation with corrected links and improved clarity
1 parent 5b3f5ae commit 3113327

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

docs/features/boomerang-tasks.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ sidebar_label: 'Boomerang Tasks'
44

55
# Boomerang Tasks: Orchestrate Complex Workflows
66

7-
Boomerang Tasks (also known as subtasks or task orchestration) allow you to break down complex projects into smaller, manageable pieces. Think of it like delegating parts of your work to specialized assistants. Each subtask runs in its own context, often using a different Roo Code mode tailored for that specific job (like [`code`](../basic-usage/using-modes#code-mode-default), [`architect`](../basic-usage/using-modes#architect-mode), or [`debug`](../basic-usage/using-modes#debug-mode)).
7+
Boomerang Tasks (also known as subtasks or task orchestration) allow you to break down complex projects into smaller, manageable pieces. Think of it like delegating parts of your work to specialized assistants. Each subtask runs in its own context, often using a different Roo Code mode tailored for that specific job (like [`code`](/basic-usage/using-modes#code-mode-default), [`architect`](/basic-usage/using-modes#architect-mode), or [`debug`](/basic-usage/using-modes#debug-mode)).
88

99
:::info Boomerang Mode is a Custom Mode
1010
The `Boomerang Mode` mentioned here is not a built-in mode but a custom mode you can create yourself. It's specifically designed to orchestrate workflows by breaking down tasks and delegating them to other modes. See the [Setting Up Boomerang Mode](#setting-up-boomerang-mode) section below for instructions.
1111

12-
Learn more about [Built-in Modes](../basic-usage/using-modes#built-in-modes) or the general process of creating [Custom Modes](./custom-modes).
12+
Learn more about [Built-in Modes](/basic-usage/using-modes#built-in-modes) or the general process of creating [Custom Modes](/features/custom-modes).
1313
:::
1414

1515
## Why Use Boomerang Tasks?
@@ -21,35 +21,29 @@ Learn more about [Built-in Modes](../basic-usage/using-modes#built-in-modes) or
2121

2222
## How It Works
2323

24-
1. Using a [Custom Mode](./custom-modes) configured for orchestration (like the [`Boomerang Mode` described below](#setting-up-boomerang-mode)), Roo can analyze a complex task and suggest breaking it down into a subtask[^1].
25-
26-
<!-- Image Placeholder: Screenshot of the subtask approval prompt in the chat -->
27-
<img src="/img/boomerang-tasks/subtask-approval.png" alt="Roo asking for approval to start a new subtask" width="600" />
24+
1. Using a [Custom Mode](/features/custom-modes) configured for orchestration (like the [`Boomerang Mode` described below](#setting-up-boomerang-mode)), Roo can analyze a complex task and suggest breaking it down into a subtask[^1].
2825

2926
2. The parent task pauses, and the new subtask begins in a different mode[^2].
3027
3. When the subtask's goal is achieved, Roo signals completion.
3128
4. The parent task resumes with only the summary[^3] of the subtask. The parent uses this summary to continue the main workflow.
3229

3330
## Key Considerations
3431

35-
- **Approval Required:** By default, you must approve the creation and completion of each subtask. This can be automated via the [Auto-Approving Actions](./auto-approving-actions#subtasks) settings if desired.
32+
- **Approval Required:** By default, you must approve the creation and completion of each subtask. This can be automated via the [Auto-Approving Actions](/features/auto-approving-actions#subtasks) settings if desired.
3633
- **Context Isolation and Transfer:** Each subtask operates in complete isolation with its own conversation history. It does not automatically inherit the parent's context. Information must be explicitly passed:
3734
* **Down:** Via the initial instructions provided when the subtask is created.
3835
* **Up:** Via the final summary provided when the subtask finishes. Be mindful that only this summary returns to the parent.
3936
- **Navigation:** Roo's interface helps you see the hierarchy of tasks (which task is the parent, which are children). You can typically navigate between active and paused tasks.
4037

41-
<!-- Image Placeholder: Screenshot of the task hierarchy/navigation UI element -->
42-
<img src="/img/boomerang-tasks/task-navigation.png" alt="UI showing parent and child tasks for navigation" width="400" />
43-
4438
Boomerang Tasks provide a powerful way to manage complex development workflows directly within Roo Code, leveraging specialized modes for maximum efficiency.
4539

4640
:::tip Keep Tasks Focused
4741

4842
## Setting Up Boomerang Mode
4943

50-
You can create your own Boomerang Mode to manage complex workflows. Follow the steps in the [Custom Modes](./custom-modes) documentation, using the text below for the key configuration fields.
44+
You can create your own Boomerang Mode to manage complex workflows. Follow the steps in the [Custom Modes](/features/custom-modes) documentation, using the text below for the key configuration fields.
5145

52-
**Recommended Tool Access:** Ensure **all tool access checkboxes are unchecked** in the "Available Tools" section when creating the mode. Boomerang Mode primarily uses the [`new_task`](./tools/new-task) capability (which doesn't require specific tool group permissions) to delegate work to other modes.
46+
**Recommended Tool Access:** Ensure **all tool access checkboxes are unchecked** in the "Available Tools" section when creating the mode. Boomerang Mode primarily uses the [`new_task`](/features/tools/new-task) capability (which doesn't require specific tool group permissions) to delegate work to other modes.
5347

5448
**Role Definition:**
5549
```text title="Copy this for the 'Role Definition' field"
@@ -66,7 +60,7 @@ Your role is to coordinate complex workflows by delegating tasks to specialized
6660
* All necessary context from the parent task or previous subtasks required to complete the work.
6761
* A clearly defined scope, specifying exactly what the subtask should accomplish.
6862
* An explicit statement that the subtask should *only* perform the work outlined in these instructions and not deviate.
69-
* An instruction for the subtask to signal completion by using the `attempt_completion` tool, providing a concise yet thourough summary of the outcome in the `result` parameter, keeping in mind that this summary will be the source of truth used to keep track of what was completed on this project.
63+
* An instruction for the subtask to signal completion by using the `attempt_completion` tool, providing a concise yet thourough summary of the outcome in the `result` parameter, keeping in mind that this summary will be the source of truth used to keep track of what was completed on this project.
7064
* A statement that these specific instructions supersede any conflicting general instructions the subtask's mode might have.
7165
7266
3. Track and manage the progress of all subtasks. When a subtask is completed, analyze its results and determine the next steps.
@@ -86,6 +80,6 @@ A downloadable `.roomodes` file containing this configuration will be available
8680
Use subtasks to maintain clarity. If a request significantly shifts focus or requires a different expertise (mode), consider creating a subtask rather than overloading the current one.
8781
:::
8882

89-
[^1]: This context is passed via the `message` parameter of the [`new_task`](./tools/new-task) tool.
90-
[^2]: The mode for the subtask is specified via the `mode` parameter of the [`new_task`](./tools/new-task) tool during initiation.
91-
[^3]: This summary is passed via the `result` parameter of the [`attempt_completion`](./tools/attempt-completion) tool when the subtask finishes.
83+
[^1]: This context is passed via the `message` parameter of the [`new_task`](/features/tools/new-task) tool.
84+
[^2]: The mode for the subtask is specified via the `mode` parameter of the [`new_task`](/features/tools/new-task) tool during initiation.
85+
[^3]: This summary is passed via the `result` parameter of the [`attempt_completion`](/features/tools/attempt-completion) tool when the subtask finishes.

0 commit comments

Comments
 (0)