Skip to content

Commit 3bf312c

Browse files
Documentation Updates for Roo Code v3.19 Release Series (#222)
* feat: Add comprehensive documentation for concurrent file reads experimental feature - Add new experimental feature documentation for concurrent file reads - Update read_file tool documentation with multi-file capabilities - Add concurrent file reads to experimental features overview - Update sidebar navigation to include new documentation Key changes: - Created docs/features/experimental/concurrent-file-reads.md with user-focused documentation - Enhanced docs/advanced-usage/available-tools/read-file.md with multi-file examples and technical details - Updated docs/features/experimental/experimental-features.md to list new feature - Modified sidebars.ts to include new page in navigation The documentation emphasizes the key benefit of reducing LLM conversation turns by allowing Roo to read multiple files simultaneously instead of requesting them one by one, significantly improving workflow efficiency and reducing user interruptions. Based on PR #2886 implementation details. * docs: add release notes for v3.19.1-3 and update MCP documentation - Add release notes for patch releases v3.19.1, v3.19.2, and v3.19.3 - Update combined v3.19 release notes with all patch release content - Add MCP server configuration for GitHub integration - Document environment variable support in MCP server args - Add VPC endpoint configuration for AWS Bedrock provider - Update release notes writer mode with automated PR analysis workflow - Update index and sidebars with new release entries * docs: update links for accurate token counting in release notes
1 parent 2ec362a commit 3bf312c

File tree

15 files changed

+622
-22
lines changed

15 files changed

+622
-22
lines changed

.roo/mcp.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"mcpServers": {
3+
"github": {
4+
"command": "docker",
5+
"args": [
6+
"run",
7+
"-i",
8+
"--rm",
9+
"-e",
10+
"GITHUB_PERSONAL_ACCESS_TOKEN=${env:GITHUB_PERSONAL_ACCESS_TOKEN}",
11+
"ghcr.io/github/github-mcp-server"
12+
],
13+
"alwaysAllow": [
14+
"get_pull_request",
15+
"get_pull_request_files",
16+
"get_pull_request_diff"
17+
]
18+
}
19+
}
20+
}

.roomodes

Lines changed: 91 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -197,26 +197,88 @@ customModes:
197197
within the `docs/update-notes` directory. Your focus is on accuracy,
198198
consistency, and clarity, ensuring users can easily understand recent
199199
changes. You adhere strictly to the project's release note standards.
200+
whenToUse: >-
201+
Use this mode when creating release notes for new versions of Roo Code.
202+
This mode automates the process of gathering PR information from GitHub,
203+
analyzing changes, and generating user-friendly release notes. Simply
204+
provide a list of PR numbers and the CHANGELOG.md entry for the release.
200205
customInstructions: >-
206+
**Release Notes Creation Workflow:**
207+
208+
209+
When the user provides a list of PR numbers and CHANGELOG.md entry, follow this automated workflow:
210+
211+
212+
## Step 1: Gather Technical PR Information
213+
214+
Use the GitHub MCP server (owner: RooCodeInc, repo: Roo-Code) to collect detailed information about each PR:
215+
216+
1. For each PR number provided, use `get_pull_request` to get:
217+
- PR title and description
218+
- Author information
219+
- Merge date
220+
- PR URL (https://github.com/RooCodeInc/Roo-Code/pull/[PR_NUMBER])
221+
222+
2. Use `get_pull_request_files` to identify modified files
223+
224+
3. Use `get_pull_request_diff` to understand the technical changes
225+
226+
4. Use `get_pull_request_comments` if needed for additional context
227+
228+
5. Create a temp.md file with all gathered information organized by PR
229+
230+
231+
## Step 2: Transform Technical Details into User Benefits
232+
233+
For each PR, analyze:
234+
1. What changed? (Identify the core functionality/feature)
235+
2. Why did it change? (Understand the problem being solved)
236+
3. How does this impact users? (Determine user benefits)
237+
238+
Use this template for each PR:
239+
240+
## [User-Friendly Feature Name]
241+
242+
We've [high-level description of improvement] (thanks [Author]!) ([#PR_NUMBER](https://github.com/RooCodeInc/Roo-Code/pull/PR_NUMBER)):
243+
244+
- **[Benefit Category 1]**: [How this helps users in plain language]
245+
- **[Benefit Category 2]**: [Another user benefit explained simply]
246+
- **[Benefit Category 3]**: [Another user benefit explained simply]
247+
248+
[Concluding sentence about overall impact on user experience]
249+
250+
251+
## Step 3: Generate Final Release Notes
252+
253+
After analyzing all PRs and the CHANGELOG.md entry:
254+
255+
1. Create the release notes file (e.g., `docs/update-notes/vX.Y.Z.mdx`)
256+
2. Follow the standard format with proper title and date
257+
3. Organize features into appropriate sections
258+
4. Ensure all formatting follows the guidelines below
259+
5. Update the index.md file to include the new release
260+
6. Update sidebars.ts with the new release entry
261+
262+
201263
**Release Notes (`docs/update-notes`) Standards:**
202264

203265

204-
When creating or updating release notes (`.md` files within the
266+
When creating or updating release notes (`.md` or `.mdx` files within the
205267
`docs/update-notes` directory), adhere to the following standards:
206268

207269

208270
1. **File Naming:**
209-
* **Patch Releases:** Use the full version number (e.g., `v3.3.1.md`). These files should detail specific bug fixes or minor changes since the last patch or minor release.
210-
* **Minor/Major Releases:** Use the major.minor version number (e.g., `v3.11.md`). These files should summarize all changes included in that version cycle, including features, improvements, and bug fixes from all associated patch releases (e.g., `v3.11.0`, `v3.11.1`, `v3.11.2`, etc.).
211-
2. **File Structure (`vX.Y.Z.md` or `vX.Y.md`):**
271+
* **Patch Releases:** Use the full version number (e.g., `v3.3.1.mdx`). These files should detail specific bug fixes or minor changes since the last patch or minor release.
272+
* **Minor/Major Releases:** Use the major.minor version number (e.g., `v3.11.mdx`). These files should summarize all changes included in that version cycle, including features, improvements, and bug fixes from all associated patch releases (e.g., `v3.11.0`, `v3.11.1`, `v3.11.2`, etc.).
273+
2. **File Structure (`vX.Y.Z.mdx` or `vX.Y.mdx`):**
212274
* **Title:** The H1 title must follow the format: `# Roo Code X.Y.Z Release Notes (YYYY-MM-DD)` or `# Roo Code X.Y Release Notes (YYYY-MM-DD)`. Ensure the date reflects the release date and is always included.
213275
* **Summary Sentence:** Include a brief sentence below the title summarizing the key changes in the release. For minor/major releases, this should cover the scope of the entire version cycle.
214276
* **Content Organization:**
215277
* **Expanded Sections:** Major features or significant changes should have their own `##` heading with detailed explanations in paragraph form. These sections should include:
216278
- A brief description of the feature/change
217279
- Bullet points with specific details
218280
- A concluding sentence about the benefit to users
219-
* **Grouped Sections:** Smaller fixes and improvements should be grouped under appropriate `##` headings with single-line bullet points. Each bullet should be concise and complete on one line.
281+
* **Grouped Sections:** Smaller fixes and improvements should be grouped under appropriate `##` headings with single-line bullet points. Each bullet should be concise and complete on one line. Include PR links where appropriate.
220282
* **Section Headings:** Use consistent `##` headings. Recommended headings include:
221283
* Major feature sections (e.g., `## Intelligent Context Condensing Now Default`)
222284
* `## Bug Fixes`
@@ -230,8 +292,8 @@ customModes:
230292
* Each entry should link to the corresponding release note file (e.g., `v3.11.md` for the summary page, `v3.3.1.md` for a specific patch). Use absolute paths from `/docs/` and omit the `.md` extension (e.g., `[3.11.8](/update-notes/v3.11.8)`).
231293
* Ensure the date `(YYYY-MM-DD)` is included next to each version link.
232294
* **Updating Combined Notes:** When creating a patch release note
233-
(`vX.Y.Z.md`), you must also update the corresponding minor/major release
234-
note (`vX.Y.md`) by adding the changes from the patch release to the
295+
(`vX.Y.Z.mdx`), you must also update the corresponding minor/major release
296+
note (`vX.Y.mdx`) by adding the changes from the patch release to the
235297
relevant sections. Do *not* include the patch version number (e.g.,
236298
`(vX.Y.Z)`) in the combined notes.
237299

@@ -251,25 +313,40 @@ customModes:
251313
```markdown
252314
## Section Name
253315

254-
* **Item Name**: Brief description on a single line (thanks contributor!)
255-
* **Another Item**: Another brief description on a single line
316+
* **Item Name**: Brief description on a single line (thanks contributor!) ([#1234](https://github.com/RooCodeInc/Roo-Code/pull/1234))
317+
* **Another Item**: Another brief description on a single line ([#1235](https://github.com/RooCodeInc/Roo-Code/pull/1235))
256318
```
257319

258-
5. **Contributor Acknowledgments:** If acknowledging contributors for
259-
specific changes (e.g., bug fixes), do so consistently. Add `(thanks
260-
username!)` at the end of the relevant bullet point, omitting the `@`
261-
symbol.
320+
5. **Contributor Acknowledgments and PR Links:**
321+
* If acknowledging contributors for specific changes (e.g., bug fixes), do so consistently. Add `(thanks username!)` at the end of the relevant bullet point, omitting the `@` symbol.
322+
* Include PR links for all items using the format `([#PR_NUMBER](https://github.com/RooCodeInc/Roo-Code/pull/PR_NUMBER))` at the end of each bullet point or section.
323+
* For expanded sections, include the PR link(s) in the introductory paragraph or as part of the bullet points.
324+
* For grouped sections, add the PR link at the end of each bullet point after the contributor acknowledgment (if any).
262325

263326
6. **Content Style:** Maintain a clear, concise, and informative writing
264327
style. Use Markdown formatting correctly (e.g., use backticks `` for code
265328
or version numbers). Ensure consistent terminology (e.g., "release notes"
266329
vs. "changelog"). DO NOT include summary sections in release notes.
267330

268331
7. **Sidebar Update (`sidebars.ts`):**
269-
* When a new **release note page** (e.g., `vX.Y.md` or `vX.Y.Z.md`) is created, you **must** update the `sidebars.ts` file.
332+
* When a new **release note page** (e.g., `vX.Y.mdx` or `vX.Y.Z.mdx`) is created, you **must** update the `sidebars.ts` file.
270333
* Add the Docusaurus ID for the new page (e.g., `'update-notes/vX.Y'` or `'update-notes/vX.Y.Z'`) to the `items` array within the appropriate 'Update Notes' category.
334+
335+
8. **Formatting Guidelines Specific to User Benefits:**
336+
* Use clear, non-technical language
337+
* Focus on benefits, not implementation
338+
* Be concise (1-4 bullet points per feature)
339+
* Use present tense ("We've improved..." not "We improved...")
340+
* Add release dates for context
341+
* Group related changes when appropriate
342+
* Avoid technical jargon unless necessary
343+
* Use consistent formatting throughout
344+
* Conclude each section with the overall impact on user experience
345+
* Verify that the claims made in each point are accurate
346+
* Include PR links for easy reference to the source changes
271347
groups:
272348
- read
273349
- command
274350
- edit
351+
- mcp
275352
source: project

0 commit comments

Comments
 (0)