Skip to content

added sub-task documentation #75

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from

Conversation

shaybc
Copy link

@shaybc shaybc commented Mar 15, 2025

Important

Adds documentation for the new_task tool, detailing its usage and benefits, and updates the tool list to include it.

  • Documentation:
    • Adds sub-tasks.md to docs/advanced-usage/, detailing the new_task tool for breaking down tasks into sub-tasks.
    • Describes benefits like reduced AI hallucinations, context overflow prevention, and improved accuracy.
    • Provides examples of how to instruct Roo Code to use new_task and manage sub-task execution.
    • Explains persistent execution with review and approval using the Auto-Approve Panel.
  • Tool List Update:
    • Updates using-tools.md to include new_task in the list of available tools, describing its function to create sub-tasks with fresh contexts.

This description was created by Ellipsis for f0ea5fb. It will automatically update as commits are pushed.

@shaybc shaybc requested review from mrubens and cte as code owners March 15, 2025 16:16
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Mar 15, 2025
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❌ Changes requested. Reviewed everything up to f0ea5fb in 2 minutes and 7 seconds

More details
  • Looked at 155 lines of code in 2 files
  • Skipped 2 files when reviewing.
  • Skipped posting 8 drafted comments based on config settings.
1. docs/basic-usage/using-tools.md:28
  • Draft comment:
    The addition of the new_task tool entry is clear and consistent with other tool descriptions. Ensure that any future changes to tool functionality are also reflected in this documentation.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
2. docs/advanced-usage/sub-tasks.md:1
  • Draft comment:
    Consider rewording the heading to 'Using the sub-task feature (new_task tool)' to remove extra spacing and improve clarity.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
3. docs/advanced-usage/sub-tasks.md:50
  • Draft comment:
    Remove the extra period and space in 'Store them in a folder (e.g., tasks)..' to clean up the punctuation.
  • Reason this comment was not posted:
    Marked as duplicate.
4. docs/basic-usage/using-tools.md:28
  • Draft comment:
    The addition of the new_task tool entry is clear and consistent with related documentation.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
5. docs/advanced-usage/sub-tasks.md:50
  • Draft comment:
    Typo: In the line 'Store them in a folder (e.g., tasks)...', there are two spaces before '(e.g., tasks)' and two periods at the end instead of one. Please fix the extra spacing and punctuation for clarity.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50%
    This is a documentation file being created, so readability is important. The typo does make the text less polished. However, our rules state not to make comments that are obvious or unimportant. This is a very minor formatting issue that doesn't affect understanding. The author can easily spot and fix these kinds of issues themselves.
    The formatting inconsistency could potentially confuse readers or make the documentation look unprofessional. Documentation quality is important.
    While documentation quality matters, this is too minor of an issue to warrant a review comment. These kinds of small formatting fixes can be handled during normal proofreading.
    Delete this comment as it points out a trivial formatting issue that doesn't significantly impact documentation quality or readability.
6. docs/advanced-usage/sub-tasks.md:72
  • Draft comment:
    Typo: The word 'withing' should be corrected to 'within' and consider using 'set up' instead of 'setup' if used as a verb. This will improve the clarity of the sentence.
  • Reason this comment was not posted:
    Marked as duplicate.
7. docs/advanced-usage/sub-tasks.md:80
  • Draft comment:
    Typo: In the sentence 'The parent task can create a sub-tasks to execute smaller workload segments,' the use of 'a' before 'sub-tasks' is incorrect. It should read either 'a sub-task' or 'sub-tasks' (without 'a') depending on the intended meaning.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 30% <= threshold 50%
    This comment is pointing out a grammatical error in the code comments or documentation. While it is not directly related to the code functionality, it does improve the readability and professionalism of the documentation. However, it doesn't fall under the rules provided, which focus on code functionality, structure, and testing. Therefore, it should be removed as it doesn't align with the rules.
8. docs/basic-usage/using-tools.md:66
  • Draft comment:
    Consider adding a period at the end of line 66 to ensure consistency with the other bullet points. Currently, the line "* Use custom instructions. Guide Roo's behavior even more with custom instructions, or change the prompt using different modes" is missing a final punctuation mark.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.

Workflow ID: wflow_ejdWKj35XjdWAWHr


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@mrubens
Copy link
Collaborator

mrubens commented Mar 17, 2025

Mind adding to the sidebar?

@hannesrudolph
Copy link
Collaborator

Already in docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants