Skip to content

Custom modes2#185

Merged
hannesrudolph merged 2 commits into
mainfrom
custom-modes2
May 13, 2025
Merged

Custom modes2#185
hannesrudolph merged 2 commits into
mainfrom
custom-modes2

Conversation

@hannesrudolph
Copy link
Copy Markdown
Collaborator

@hannesrudolph hannesrudolph commented May 13, 2025

Important

Improved documentation for custom modes and shell integration in Roo Code, including new settings, configuration methods, and troubleshooting steps.

  • Custom Modes Documentation:
    • Restructured to clarify creation and configuration methods, including using Roo, the Prompts tab, and manual JSON editing.
    • Detailed explanation of JSON properties: slug, name, roleDefinition, groups, and customInstructions.
    • Added examples for mode-specific instruction files and directories.
    • Expanded section on regex usage for file restrictions.
  • Shell Integration Documentation:
    • Added new settings: "Compress progress bar output" and "Inherit environment variables".
    • Updated troubleshooting steps for shell integration issues, including PowerShell and ZSH-specific settings.
    • Detailed explanation of terminal integration settings and their impact on command execution.

This description was created by Ellipsis for 3ac7dae. You can customize this summary. It will automatically update as commits are pushed.

@hannesrudolph hannesrudolph requested review from cte and mrubens as code owners May 13, 2025 16:19
@vercel
Copy link
Copy Markdown

vercel Bot commented May 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
roo-code-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 13, 2025 4:20pm

@dosubot dosubot Bot added the size:L This PR changes 100-499 lines, ignoring generated files. label May 13, 2025
@hannesrudolph hannesrudolph merged commit 006fbcb into main May 13, 2025
3 checks passed
@hannesrudolph hannesrudolph deleted the custom-modes2 branch May 13, 2025 16:21
@dosubot dosubot Bot added the documentation Improvements or additions to documentation label May 13, 2025
Copy link
Copy Markdown
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.

Important

Looks good to me! 👍

Reviewed everything up to 3ac7dae in 2 minutes and 16 seconds. Click for details.
  • Reviewed 570 lines of code in 2 files
  • Skipped 3 files when reviewing.
  • Skipped posting 8 draft comments. View those below.
  • Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.
1. docs/features/custom-modes.md:5
  • Draft comment:
    The updated tip block on Sticky Models improves clarity. Ensure its styling is consistent with other info/tip blocks in the docs.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None
2. docs/features/custom-modes.md:24
  • Draft comment:
    The new properties table for 'What's Included in a Custom Mode?' is well-structured. Verify table alignment renders correctly across markdown viewers.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None
3. docs/features/custom-modes.md:73
  • Draft comment:
    JSON examples correctly double-escape backslashes in regex patterns. Nice job ensuring valid JSON configurations.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50% None
4. docs/features/shell-integration.md:49
  • Draft comment:
    The 'Compress progress bar output' setting description is clear. Consider adding a brief note on any potential performance trade-offs.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None
5. docs/features/shell-integration.md:66
  • Draft comment:
    The Advanced Settings section is comprehensive. For improved scannability, consider grouping related settings under subheadings.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50% None
6. docs/features/custom-modes.md:5
  • Draft comment:
    It appears that the admonition block for 'Sticky Models for Efficient Workflow' uses four colons (e.g. '::::tip') instead of the typical three-colon syntax (':::tip'). Please verify and adjust the syntax to align with our Markdown standards.
  • 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% The comment suggests changing from four colons to three, claiming three is "typical". However, the document consistently uses four colons across multiple admonition blocks. This suggests four colons is the intended style for this project. Without seeing the actual markdown rendering engine configuration, we can't assume three colons is "standard" - different markdown processors handle admonitions differently. The comment could be correct if there's a project-wide markdown standard document specifying three colons. But I don't have access to that information. Given the consistent use of four colons throughout this document and no clear evidence of a three-colon standard, the comment appears to be making an incorrect assumption. The comment should be deleted since it's making assumptions about markdown standards without evidence, and the four-colon style is used consistently throughout the document.
7. docs/features/custom-modes.md:292
  • Draft comment:
    In the Common Pattern Examples table, the regex patterns for CSS/SCSS files and JS/TS files contain extra backslashes before the pipe character (e.g., ".(css|scss)$" and "^(?!.(test|spec)).(js|ts)$"). These likely should be ".(css|scss)$" and "^(?!.(test|spec)).(js|ts)$". Please review and correct these escapes as needed.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 0% vs. threshold = 50% The comment misunderstands the purpose of these examples. The documentation is explicitly showing how to properly escape regex patterns in JSON strings. The extra backslashes are intentional and correct, as they're showing the JSON representation. This is reinforced by the surrounding context which explains the double backslash rule and shows examples of both raw regex and JSON-escaped versions. Could the documentation be clearer about when it's showing raw regex vs JSON-escaped patterns? The current format might confuse some readers. While the presentation could potentially be clearer, the patterns as shown are technically correct for their intended purpose - demonstrating JSON configuration. The comment should be deleted as it incorrectly suggests removing necessary escaping in JSON string contexts.
8. docs/features/shell-integration.md:25
  • Draft comment:
    It appears that 'Update VSCode/Cursor' might be a typographical error. Consider revising this to simply 'Update VSCode' (or whichever term is appropriate) to improve clarity.
  • 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_KAoKvHjxhMN2qBF0

You can customize Ellipsis by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.

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.

1 participant