Clarify custom mode YAML parsing limitations #237
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit updates the documentation for manually editing custom modes (`.roomodes`) to improve clarity and help users avoid some parsing pitfalls discovered during real-world testing. The key changes include: * Adding a new "Troubleshooting & Known Limitations" section to centralize practical advice. * Clarifying that YAML Anchors & Aliases (`&`, `*`) are not supported by the parser. * Warning that the complex `fileRegex` permission syntax is unstable and recommending a simpler, more reliable alternative (`groups: [read, edit]`). * Adding guidance on basic details like ensuring UTF-8 file encoding and avoiding invisible characters in indentation. These updates provide an accurate reflection of the YAML parser's behavior and will lead to a better user experience.
|
@HumanSpark is attempting to deploy a commit to the Roo Code Team on Vercel. A member of the Team first needs to authorize it. |
![ellipsis-dev[bot]](https://avatars.githubusercontent.com/in/64358?s=60&v=4){kind=small}
Member
|
Thank you @HumanSpark! @hannesrudolph can you take a look? |
Collaborator
|
@HumanSpark why not just fix the limitation? |
Author
Good question. Lack of confidence mostly! I've never used git before, and haven't "coded in anger" in decades. |
Member
|
Should be fixed by RooCodeInc/Roo-Code#5099 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit updates the documentation for manually editing custom modes (
.roomodes) to improve clarity and help users avoid some parsing pitfalls discovered during real-world testing.The key changes include:
&,*) are not supported by the parser.fileRegexpermission syntax is unstable and recommending a simpler, more reliable alternative (groups: [read, edit]).These updates provide an accurate reflection of the YAML parser's behavior and will lead to a better user experience.
Important
Updates documentation to clarify YAML parsing limitations for custom modes, including unsupported features and recommended practices.
custom-modes.mdx.&,*).fileRegexsyntax due to instability.groups: [read, edit]permissions.This description was created by
for 4e1e043. You can customize this summary. It will automatically update as commits are pushed.