Skip to content

Commit d5bf1b4

Browse files
docs: v3.28.3 release notes and v3.28 combined sync\n\n- Add v3.28.3 patch notes and align combined v3.28 notes\n- Correct keyboard shortcut docs (roo-cline.* IDs; Add to Context Cmd+Y/Ctrl+Y; focus note)\n- Update Auto-Approve docs to match new UI (Enabled toggle position, All/None chips)\n- Add Z.ai region-aware plan details; ByteString troubleshooting; related doc tweaks\n- Keep index and sidebar in sync (#344)
1 parent 9adf4ef commit d5bf1b4

File tree

16 files changed

+175
-111
lines changed

16 files changed

+175
-111
lines changed

.roo/rules-release-notes-writer/1_main_workflow.xml

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,12 @@ gh pr list --repo RooCodeInc/Roo-Code --state merged --base main --limit 1000 \
108108
<details>
109109
Parent task MUST create this file (and .roo/tmp/release-notes/temp_pr_inclusion_v[version].json, .roo/tmp/release-notes/temp_pr_list_v[VERSION].md if needed) before ANY subtasks.
110110
Subtasks will ONLY append using insert_content.
111+
Parent task MUST NOT append to temp_pr_analysis_v[version].md; this file is reserved exclusively for subtask outputs. The parent may only create/initialize the empty file(s).
111112
Temp files live under .roo/tmp/release-notes/
112113
</details>
113114
</initialization>
114115

115-
<subtask_pattern>
116+
<subtask_pattern priority="CRITICAL">
116117
<for_each>PR in list</for_each>
117118
<action>Create investigation subtask using new_task tool</action>
118119
<implementation>
@@ -128,22 +129,23 @@ gh pr list --repo RooCodeInc/Roo-Code --state merged --base main --limit 1000 \
128129
</iteration_approach>
129130
</implementation>
130131
<message_template><![CDATA[
131-
Investigate PR #[number] for release notes v[version].
132-
1. Get PR details: gh pr view [number] --repo RooCodeInc/Roo-Code --json number,title,author,mergedAt,labels,body,url
133-
2. Extract linked issues from PR body
134-
3. Get issue details if linked
135-
4. Categorize change (Feature/QOL/Bug Fix/Provider Update)
136-
5. Identify documentation needs (new features, behavior changes, deprecations)
137-
6. Append to .roo/tmp/release-notes/temp_pr_analysis_v[version].md using insert_content line 0
138-
139-
Include documentation flags:
140-
- docs-new: Completely new feature
141-
- docs-update: Existing docs need updating
142-
- docs-example: New examples needed
143-
- docs-migration: Breaking changes
144-
145-
CRITICAL: Never create/overwrite files, only append.
146-
]]></message_template>
132+
Investigate PR #[number] for release notes v[version].
133+
1. Get PR details: gh pr view [number] --repo RooCodeInc/Roo-Code --json number,title,author,mergedAt,labels,body,url
134+
2. Extract linked issues from PR body
135+
3. Get issue details if linked
136+
4. Categorize change (Feature/QOL/Bug Fix/Provider Update)
137+
5. Identify documentation needs (new features, behavior changes, deprecations)
138+
6. Append to .roo/tmp/release-notes/temp_pr_analysis_v[version].md using insert_content line 0
139+
140+
Include documentation flags:
141+
- docs-new: Completely new feature
142+
- docs-update: Existing docs need updating
143+
- docs-example: New examples needed
144+
- docs-migration: Breaking changes
145+
146+
CRITICAL: Never create/overwrite files, only append.
147+
MANDATORY: Insert the marker line '<!-- generated-by-subtask: true -->' immediately before the '---' separator in each PR entry.
148+
]]></message_template>
147149
<todos_template><![CDATA[
148150
[ ] Fetch PR #[number] details using gh pr view --repo RooCodeInc/Roo-Code
149151
[ ] Extract linked issues from PR body
@@ -164,6 +166,7 @@ CRITICAL: Never create/overwrite files, only append.
164166
**Contributors**: [list]
165167
**Documentation Needs**: [none|docs-new|docs-update|docs-example|docs-migration]
166168
**Documentation Notes**: [If applicable, what needs documenting]
169+
<!-- generated-by-subtask: true -->
167170
168171
---
169172
]]></output_format>
@@ -328,7 +331,8 @@ gh pr view N --repo RooCodeInc/Roo-Code --json number,title,author,mergedAt,labe
328331
<file optional="true">.roo/tmp/release-notes/temp_pr_inclusion_v[version].json</file>
329332
</inputs>
330333
<precondition>
331-
If .roo/tmp/release-notes/temp_pr_inclusion_v[version].json does not exist, you MUST execute the changelog_alignment phase now to obtain an inclusion decision, then retry this step.
334+
- Inclusion policy required: If .roo/tmp/release-notes/temp_pr_inclusion_v[version].json does not exist, you MUST execute the changelog_alignment phase now to obtain an inclusion decision, then retry this step.
335+
- Subtask provenance required: All PR analysis entries MUST contain the marker '<!-- generated-by-subtask: true -->'. If any entries are missing this marker, HALT and re-run PR analysis via per-PR subtasks before proceeding.
332336
</precondition>
333337
<filtering>
334338
Include only PRs listed in "included" from .roo/tmp/release-notes/temp_pr_inclusion_v[version].json. Do not fall back to using all analyzed PRs without an explicit inclusion policy.
@@ -501,6 +505,9 @@ gh pr list --repo RooCodeInc/Roo-Code --state merged --base main --limit 1000 \
501505
<rule priority="CRITICAL">
502506
Parent task creates temp files, subtasks only append
503507
</rule>
508+
<rule priority="CRITICAL">
509+
For each PR, the parent MUST create a subtask via new_task. The parent MUST NOT write PR analysis entries; only subtasks may append to .roo/tmp/release-notes/temp_pr_analysis_v[version].md. Do not proceed to changelog_alignment or compilation until all PR subtasks complete.
510+
</rule>
504511
<rule priority="CRITICAL">
505512
Use the simplified PR extraction command for consistent results
506513
</rule>

.roorules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This ensures links work correctly in the built documentation while maintaining c
1111
When making structural or formatting changes beyond simple .md or .mdx files, always check the Context7 MCP, the `context7CompatibleLibraryID` will be `/facebook/docusaurus`
1212

1313
## Release Notes "thank you" exclusions
14-
Do not thank daniel-lxs, cte, hannesrudolph, jr, roomote, app/roomote, dleffel or mrubens in release notes
14+
Do not thank daniel-lxs, cte, hannesrudolph, jr, roomote, app/roomote, dleffel, brunobergher or mrubens in release notes
1515

1616

1717
## Misc

docs/features/auto-approving-actions.mdx

Lines changed: 21 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -38,37 +38,22 @@ Auto-approve settings speed up your workflow by eliminating repetitive confirmat
3838

3939
## Quick Start Guide
4040

41-
1. Click the Auto-Approve Toolbar above the chat input
42-
2. Select which actions Roo can perform without asking permission
43-
3. Use the master toggle (leftmost checkbox) to quickly enable/disable all permissions
41+
1. Open the Auto-Approve dropdown next to the chat input
42+
2. Toggle "Enabled" at the bottom-right of the dropdown to activate or pause auto-approval
43+
3. Use the All/None chips to bulk-select or clear permissions, or select individual tiles; you can keep Enabled On with "None" selected
44+
4. (Optional) Click the gear icon to open Settings for deeper per-permission controls
4445

4546
---
4647

47-
## Auto-Approve Toolbar
48+
## Auto-Approve Dropdown
4849

49-
<img src="/img/auto-approving-actions/auto-approving-actions.png" alt="Auto-approve toolbar collapsed state" width="600" />
50+
<img src="/img/auto-approving-actions/auto-approving-actions-20.png" alt="Auto-Approve dropdown with All/None chips and global Enabled toggle (bottom-right)" width="600" />
5051

51-
*Prompt box and Auto-Approve Toolbar showing enabled permissions*
52+
The dropdown shows a grid of permission tiles. Controls:
53+
- Enabled (bottom-right): master pause/resume for auto-approval
54+
- All / None (bottom-left): bulk select or clear permissions without changing Enabled
55+
- Permission tiles: choose which actions can run without prompts; some tiles may be disabled depending on model or mode
5256

53-
Click the toolbar to expand it and configure individual permissions:
54-
55-
<img src="/img/auto-approving-actions/auto-approving-actions-1.png" alt="Auto-approve toolbar expanded state" width="600" />
56-
57-
*Prompt text box and Expanded toolbar with all options*
58-
59-
### API Request Limit
60-
61-
The toolbar includes an input field to set the maximum number of API requests Roo can make automatically:
62-
63-
- **Purpose**: Prevents runaway API usage and unexpected costs
64-
- **Default**: No limit (empty field)
65-
- **Recommended**: Set a reasonable limit based on your task complexity (e.g., 50-100 for most tasks)
66-
- **How it works**: Once the limit is exceeded, Roo will pause and show a dialog allowing you to reset the counter and continue
67-
68-
This safety feature is particularly useful when:
69-
- Working with expensive API models
70-
- Testing new workflows
71-
- Letting Roo work autonomously for extended periods
7257

7358
### Available Permissions
7459

@@ -87,30 +72,19 @@ This safety feature is particularly useful when:
8772

8873
---
8974

90-
## Master Toggle for Quick Control
75+
## Global Enabled Switch
9176

92-
The leftmost checkbox works as a master toggle:
77+
<img src="/img/auto-approving-actions/auto-approving-actions-21.png" alt="Auto-Approve dropdown; Enabled at bottom-right and All/None chips at bottom-left" width="600" />
9378

94-
<img src="/img/auto-approving-actions/auto-approving-actions-14.png" alt="Master toggle in Auto-approve toolbar" width="600" />
79+
How it works:
80+
- Enabled On — Auto-approval runs for the permissions you’ve selected
81+
- Enabled Off — Pauses all auto-approvals; your per-permission selections persist
82+
- All / None — Bulk adjust selections while Enabled remains unchanged
9583

96-
*Master toggle (checkbox) controls all auto-approve permissions at once*
97-
98-
**How it works:**
99-
- **Checked**: Activates all configured auto-approve permissions
100-
- **Unchecked**: Temporarily disables all auto-approvals without changing individual settings
101-
- **Important**: Individual permission settings are preserved when toggling
102-
- **Note**: The master toggle is temporarily disabled while the auto-approve menu is expanded
103-
104-
This means you can:
105-
1. Configure your preferred permissions once
106-
2. Use the master toggle to quickly enable/disable them all
107-
3. Your configuration remains intact for next time
108-
109-
Use the master toggle when:
110-
- Working in sensitive code (turn off)
111-
- Doing rapid development (turn on)
84+
When to toggle:
85+
- Sensitive or production work → Off
86+
- Rapid iteration and refactors → On
11287
- Switching between exploration and editing tasks
113-
- Temporarily pausing automation without losing settings
11488

11589
---
11690

@@ -122,11 +96,10 @@ The settings panel provides detailed control with important security context:
12296
12397
To access these settings:
12498

125-
1. Click <Codicon name="gear" /> in the top-right corner
99+
1. Click <Codicon name="gear" /> in the top-right of the dropdown
126100
2. Navigate to Auto-Approve Settings
127101

128-
<img src="/img/auto-approving-actions/auto-approving-actions-19.png" alt="Settings panel auto-approve options" width="550" />
129-
*Complete settings panel view*
102+
The settings panel mirrors the same permissions with additional context and safeguards.
130103

131104
### Read Operations
132105

docs/features/code-actions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ The **Add to Context** action is listed first in the Code Actions menu so you ca
6262

6363
This helps Roo understand the exact context of your code within the project, allowing it to provide more relevant and accurate assistance.
6464

65+
Tip: Use macOS Cmd+' or Windows/Linux Ctrl+' to add the selection to context quickly. See [Keyboard Shortcuts](/features/keyboard-shortcuts).
66+
6567
**Example Chat Input:**
6668

6769
```

docs/features/codebase-indexing.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,15 @@ Use natural language descriptions:
282282
- Ensure the key has necessary permissions
283283
- For Ollama, verify the service is running
284284

285+
### API Key Format Errors (“ByteString conversion”)
286+
287+
- Symptom: Error mentions "ByteString conversion" during indexing or when saving settings
288+
- Likely cause: Your embedding provider API key contains invalid/special characters or hidden whitespace
289+
- Fix:
290+
- Regenerate a fresh API key from your provider dashboard
291+
- Paste the key again, ensuring no leading/trailing spaces or hidden characters
292+
- Roo will display a clear validation message if the key is invalid
293+
285294
### Model Issues
286295

287296
**"Model Not Found"**

docs/features/keyboard-shortcuts.md

Lines changed: 34 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: Master keyboard navigation in Roo Code with customizable shortcuts,
33
keywords:
44
- keyboard shortcuts
55
- keyboard navigation
6-
- roo.acceptInput
6+
- roo-cline.acceptInput
77
- prompt history
88
- accessibility
99
- vim compatibility
@@ -19,12 +19,13 @@ The Roo Code interface supports keyboard navigation and shortcuts to streamline
1919

2020
## Available Keyboard Commands
2121

22-
Roo Code offers keyboard commands to enhance your workflow. This page focuses on the `roo.acceptInput` command, but here's a quick reference to all keyboard commands:
22+
Roo Code offers keyboard commands to enhance your workflow. This page focuses on the `roo-cline.acceptInput` command, but here's a quick reference to all keyboard commands:
2323

2424
| Command | Description | Default Shortcut |
2525
|---------|-------------|-----------------|
26-
| `roo.acceptInput` | Submit text or accept the primary suggestion | None (configurable) |
27-
| `roo.focus` | Focus the Roo input box | None (configurable) |
26+
| `roo-cline.acceptInput` | Submit text or accept the primary suggestion | None (configurable) |
27+
| `roo-cline.focusInput` | Focus the Roo input box | None (configurable) |
28+
| Add to Context | Add selected code to Roo's context | macOS: Cmd+Y; Windows/Linux: Ctrl+Y |
2829
| Arrow Up/Down | Navigate through prompt history | Built-in |
2930

3031
### Key Benefits of Keyboard Commands
@@ -36,13 +37,13 @@ Roo Code offers keyboard commands to enhance your workflow. This page focuses on
3637

3738
---
3839

39-
## roo.acceptInput Command
40+
## roo-cline.acceptInput Command
4041

41-
The `roo.acceptInput` command lets you submit text or accept suggestions with keyboard shortcuts instead of clicking buttons or pressing Enter in the input area.
42+
The `roo-cline.acceptInput` command lets you submit text or accept suggestions with keyboard shortcuts instead of clicking buttons or pressing Enter in the input area.
4243

4344
### What It Does
4445

45-
The `roo.acceptInput` command is a general-purpose input submission command. When triggered, it:
46+
The `roo-cline.acceptInput` command is a general-purpose input submission command. When triggered, it:
4647

4748
- Submits your current text or image input when in the text input area (equivalent to pressing Enter)
4849
- Clicks the primary (first) button when action buttons are visible (such as confirm/cancel buttons or any other action buttons)
@@ -53,7 +54,7 @@ The `roo.acceptInput` command is a general-purpose input submission command. Whe
5354

5455
1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac)
5556
2. Type "Preferences: Open Keyboard Shortcuts"
56-
3. In the search box, type "roo.acceptInput"
57+
3. In the search box, type "roo-cline.acceptInput"
5758
4. Locate "Roo: Accept Input/Suggestion" in the results
5859
5. Click the + icon to the left of the command
5960
6. Press your desired key combination (e.g., `Ctrl+Enter` or `Alt+Enter`)
@@ -69,17 +70,26 @@ The `roo.acceptInput` command is a general-purpose input submission command. Whe
6970
```json
7071
{
7172
"key": "ctrl+enter", // or your preferred key combination
72-
"command": "roo.acceptInput",
73-
"when": "rooViewFocused" // This is a context condition that ensures the command only works when Roo is focused
73+
"command": "roo-cline.acceptInput",
74+
"when": "view == roo-cline.SidebarProvider || activeWebviewPanelId == roo-cline.TabPanelProvider"
7475
}
7576
```
7677

77-
You can also use a more specific condition:
78+
Scoped examples:
79+
- Sidebar Roo view only:
7880
```json
7981
{
8082
"key": "ctrl+enter",
81-
"command": "roo.acceptInput",
82-
"when": "webviewViewFocus && webviewViewId == 'roo-cline.SidebarProvider'"
83+
"command": "roo-cline.acceptInput",
84+
"when": "view == roo-cline.SidebarProvider"
85+
}
86+
```
87+
- Editor Roo tab only:
88+
```json
89+
{
90+
"key": "ctrl+enter",
91+
"command": "roo-cline.acceptInput",
92+
"when": "activeWebviewPanelId == roo-cline.TabPanelProvider"
8393
}
8494
```
8595

@@ -92,6 +102,12 @@ Choose a key combination that doesn't conflict with existing VS Code shortcuts:
92102
- `Ctrl+Enter` - Intuitive for command execution
93103
- `Alt+A` - Mnemonic for "Accept"
94104

105+
## Add to Context Shortcut
106+
107+
- Default: macOS Cmd+Y; Windows/Linux Ctrl+Y
108+
- Requires: when condition `editorTextFocus && editorHasSelection`
109+
- Focus does not change automatically. To continue typing immediately, use “Roo: Focus Input” (`roo-cline.focusInput`) or click into the Roo panel.
110+
95111
### Practical Use Cases
96112

97113
#### Quick Development Workflows
@@ -117,7 +133,7 @@ Choose a key combination that doesn't conflict with existing VS Code shortcuts:
117133

118134
### Accessibility Benefits
119135

120-
The `roo.acceptInput` command was designed with accessibility in mind:
136+
The `roo-cline.acceptInput` command was designed with accessibility in mind:
121137

122138
- **Reduced Mouse Dependence**: Complete entire workflows without reaching for the mouse
123139
- **Reduced Physical Strain**: Helps users who experience discomfort or pain from mouse usage
@@ -133,7 +149,7 @@ Here are some complete workflow examples showing how to effectively use keyboard
133149
1. Open VS Code and navigate to your project
134150
2. Open Roo via the sidebar
135151
3. Type your request: "Create a REST API endpoint for user registration"
136-
4. When Roo asks for framework preferences, use your `roo.acceptInput` shortcut to select the first suggestion
152+
4. When Roo asks for framework preferences, use your `roo-cline.acceptInput` shortcut to select the first suggestion
137153
5. Continue using the shortcut to accept code generation suggestions
138154
6. When Roo offers to save the file, use the shortcut again to confirm
139155
7. Use VS Code's built-in shortcuts to navigate through the created files
@@ -153,13 +169,13 @@ Here are some complete workflow examples showing how to effectively use keyboard
153169
| Wrong suggestion selected | The command always selects the first (primary) button; use mouse if you need a different option |
154170
| Conflicts with existing shortcuts | Try a different key combination in VS Code keyboard settings |
155171
| No visual feedback when used | This is normal - the command silently activates the function without visual confirmation |
156-
| Shortcut works inconsistently | Make sure the `when` clause is properly configured in your keybindings.json (either `rooViewFocused` or the webview-specific condition) |
172+
| Shortcut works inconsistently | Make sure the `when` clause is properly configured (use `view == roo-cline.SidebarProvider` or `activeWebviewPanelId == roo-cline.TabPanelProvider`) |
157173

158174
### Technical Implementation
159175

160-
The `roo.acceptInput` command is implemented as follows:
176+
The `roo-cline.acceptInput` command is implemented as follows:
161177

162-
- Command registered as `roo.acceptInput` with display title "Roo: Accept Input/Suggestion" in the command palette
178+
- Command registered as `roo-cline.acceptInput` with display title "Roo: Accept Input/Suggestion" in the command palette
163179
- When triggered, it sends an "acceptInput" message to the active Roo webview
164180
- The webview determines the appropriate action based on the current UI state:
165181
- Clicks the primary action button if action buttons are visible and enabled

0 commit comments

Comments
 (0)