You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
When creating or updating release notes (`.md` files within the
266
+
When creating or updating release notes (`.md` or `.mdx` files within the
205
267
`docs/update-notes` directory), adhere to the following standards:
206
268
207
269
208
270
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`):**
212
274
* **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.
213
275
* **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.
214
276
* **Content Organization:**
215
277
* **Expanded Sections:** Major features or significant changes should have their own `##` heading with detailed explanations in paragraph form. These sections should include:
216
278
- A brief description of the feature/change
217
279
- Bullet points with specific details
218
280
- 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.
220
282
* **Section Headings:** Use consistent `##` headings. Recommended headings include:
221
283
* Major feature sections (e.g., `## Intelligent Context Condensing Now Default`)
222
284
* `## Bug Fixes`
@@ -230,8 +292,8 @@ customModes:
230
292
* 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)`).
231
293
* Ensure the date `(YYYY-MM-DD)` is included next to each version link.
232
294
* **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
235
297
relevant sections. Do *not* include the patch version number (e.g.,
236
298
`(vX.Y.Z)`) in the combined notes.
237
299
@@ -251,25 +313,40 @@ customModes:
251
313
```markdown
252
314
## Section Name
253
315
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))
256
318
```
257
319
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).
262
325
263
326
6. **Content Style:** Maintain a clear, concise, and informative writing
264
327
style. Use Markdown formatting correctly (e.g., use backticks `` for code
265
328
or version numbers). Ensure consistent terminology (e.g., "release notes"
266
329
vs. "changelog"). DO NOT include summary sections in release notes.
267
330
268
331
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.
270
333
* 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
0 commit comments