Skip to content

Conversation

@hannesrudolph
Copy link
Collaborator

@hannesrudolph hannesrudolph commented Feb 18, 2025

Important

Rewrites documentation for custom instructions and modes in Roo Code, detailing setup, configuration, and usage with examples.

  • Custom Instructions:
    • Introduces global and workspace-level custom instructions in custom-instructions.md.
    • Adds preferred language setting in the Prompts tab.
    • Details how instructions are combined in the system prompt.
    • Explains rule file usage and interaction.
  • Custom Modes:
    • Describes creating global and project-specific custom modes in custom-modes.md.
    • Details JSON format for mode configuration, including required and optional properties.
    • Explains configuration precedence and file restrictions using regex.
    • Provides examples of mode configurations, including project-specific overrides.

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

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.

👍 Looks good to me! Reviewed everything up to d4052a0 in 1 minute and 52 seconds

More details
  • Looked at 433 lines of code in 2 files
  • Skipped 0 files when reviewing.
  • Skipped posting 6 drafted comments based on config settings.
1. docs/advanced-usage/custom-instructions.md:5
  • Draft comment:
    Good update, but consider clarifying the distinction between global vs workspace-level instructions using consistent terminology.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
2. docs/advanced-usage/custom-modes.md:6
  • Draft comment:
    The reworked custom modes documentation is clear. Ensure JSON examples consistently follow our formatting conventions.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is asking the PR author to ensure consistency in JSON formatting, which is a general request for confirmation or double-checking. It doesn't provide a specific suggestion or point out a specific issue in the code. Therefore, it violates the rule against asking the author to ensure or confirm things.
3. docs/advanced-usage/custom-instructions.md:5
  • Draft comment:
    The updated structure now clearly distinguishes between Global and Workspace-Level Instructions. This clarification makes it easier for users to understand the scope of each setting.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
4. docs/advanced-usage/custom-instructions.md:47
  • Draft comment:
    The code block outlining the combined format for custom instructions is very clear. Consider adding a brief note that the 'Language Preference' is optional if not set, to guide users.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50%
    None
5. docs/advanced-usage/custom-modes.md:60
  • Draft comment:
    The 'Configuration Precedence' section is well explained. It clearly shows that project-specific modes override global and default ones. A small inline note emphasizing that default modes can be overridden might improve clarity further.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50%
    None
6. docs/advanced-usage/custom-modes.md:144
  • Draft comment:
    The JSON examples are detailed and formatted clearly, illustrating required fields and file restriction usage. Consider adding an additional example featuring a minimal mode configuration (omitting optional fields like customInstructions) for complete coverage.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50%
    None

Workflow ID: wflow_XYSAW2NcE20Yns0d


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link
Collaborator

@mrubens mrubens left a comment

Choose a reason for hiding this comment

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

❤️

@mrubens mrubens merged commit f764ce3 into RooCodeInc:main Feb 18, 2025
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants