Update custom modes to YAML #105
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates the custom modes documentation to transition from JSON-first to YAML-first configuration format. It significantly enhances the documentation structure to provide comprehensive guidance on creating and managing custom modes in Kilo Code.
Key changes include:
- Introducing YAML as the preferred configuration format with comprehensive examples
- Adding import/export functionality for sharing and backing up modes
- Restructuring content organization with improved sections and clearer explanations
|
|
||
| <img src="/docs/img/custom-modes/custom-modes.png" alt="Overview of custom modes interface" width="400" /> | ||
| *Kilo Code's interface for creating and managing custom modes.* | ||
| <img src="/img/custom-modes/custom-modes.png" alt="Overview of custom modes interface" width="600" /> |
There was a problem hiding this comment.
The image path has changed from /docs/img/ to /img/. Ensure this path exists and is accessible in the documentation system, or verify that this path change is intentional and correctly reflects the new location.
| <img src="/img/custom-modes/custom-modes.png" alt="Overview of custom modes interface" width="600" /> | |
| <img src="/docs/img/custom-modes/custom-modes.png" alt="Overview of custom modes interface" width="600" /> |
Copilot uses AI. Check for mistakes.
| 2. **Create New Mode:** Click the <Codicon name="add" /> button to the right of the Modes heading | ||
| 3. **Fill in Fields:** | ||
|
|
||
| <img src="/img/custom-modes/custom-modes-2.png" alt="Custom mode creation interface in the Prompts tab" width="600" /> |
There was a problem hiding this comment.
Similar to the previous image, the path has changed from /docs/img/ to /img/. Verify that this path change is intentional and that the image is accessible at the new location.
| <img src="/img/custom-modes/custom-modes-2.png" alt="Custom mode creation interface in the Prompts tab" width="600" /> | |
| <img src="/docs/img/custom-modes/custom-modes-2.png" alt="Custom mode creation interface in the Prompts tab" width="600" /> |
Copilot uses AI. Check for mistakes.
| - - edit # First element of tuple | ||
| - fileRegex: \.(md|mdx)$ # Second element is the options object | ||
| description: Markdown files only |
There was a problem hiding this comment.
The YAML syntax here is confusing. The nested array structure - - edit is unusual and may not be the intended representation for the tuple format. Consider clarifying this syntax or providing a clearer example of how to represent the tuple in YAML.
| - - edit # First element of tuple | |
| - fileRegex: \.(md|mdx)$ # Second element is the options object | |
| description: Markdown files only | |
| - [edit, { fileRegex: \.(md|mdx)$, description: "Markdown files only" }] |
Copilot uses AI. Check for mistakes.
| - - edit # First element of tuple | ||
| - fileRegex: \.(js|ts)$ # Second element is the options object | ||
| description: JS/TS files only |
There was a problem hiding this comment.
This repeats the same confusing YAML tuple syntax. The double hyphen structure - - edit is not standard YAML and may confuse readers. Consider using a clearer representation or providing additional explanation about this specific syntax.
| - - edit # First element of tuple | |
| - fileRegex: \.(js|ts)$ # Second element is the options object | |
| description: JS/TS files only | |
| - [edit, {fileRegex: \.(js|ts)$, description: JS/TS files only}] |
Copilot uses AI. Check for mistakes.
| - - edit | ||
| - fileRegex: \.(js|ts)$ | ||
| description: JS/TS files only |
There was a problem hiding this comment.
This is another instance of the confusing double hyphen syntax. For consistency and clarity, all tuple representations in YAML examples should use a clear, standard format that readers can easily understand and implement.
| - - edit | |
| - fileRegex: \.(js|ts)$ | |
| description: JS/TS files only | |
| - edit: | |
| - fileRegex: \.(js|ts)$ | |
| description: JS/TS files only |
Copilot uses AI. Check for mistakes.
| - - edit | ||
| - fileRegex: \.py$ |
There was a problem hiding this comment.
Another instance of the unclear tuple syntax in YAML. This pattern appears multiple times throughout the document and should be standardized for clarity.
| - - edit | |
| - fileRegex: \.py$ | |
| - edit: | |
| fileRegex: \.py$ |
Copilot uses AI. Check for mistakes.
| - - edit | ||
| - fileRegex: \.(test|spec)\.(js|ts)$ |
There was a problem hiding this comment.
Final instance of the confusing YAML tuple syntax. Consider providing a comprehensive explanation of this syntax in the document or using a more intuitive representation.
| - - edit | |
| - fileRegex: \.(test|spec)\.(js|ts)$ | |
| - edit: | |
| fileRegex: \.(test|spec)\.(js|ts)$ |
Copilot uses AI. Check for mistakes.
Closes #104