Skip to content

Commit e2885ac

Browse files
Misc2 (#221)
* docs: Add FAQ entry for issues writing to markdown files and provide troubleshooting steps * docs: Update fast edits documentation and add new settings image * docs: Update Fast Edits documentation to clarify configuration and rename section
1 parent 20b7b7c commit e2885ac

File tree

4 files changed

+30
-7
lines changed

4 files changed

+30
-7
lines changed

docs/faq.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,27 @@ The error message should provide some information about the problem. If you're u
162162

163163
Roo Code uses VS Code's built-in file editing capabilities. You can use the standard "Undo" command (Ctrl/Cmd + Z) to revert changes. Also, if experimental checkpoints are enabled, Roo can revert changes made to a file.
164164

165+
### Roo Code can't write to markdown files. What's wrong?
166+
167+
If Roo Code fails to write to `.md` files with errors like "Failed to open diff editor" or "write_to_file tool failed", this is typically caused by VS Code extensions or settings that interfere with file editing:
168+
169+
**Common causes:**
170+
- Extensions with "format on save" functionality
171+
- VS Code settings that open markdown files in preview mode by default
172+
- The Markdown Preview extension or similar markdown processing extensions
173+
174+
**Solutions:**
175+
- Disable any extensions that automatically format files on save
176+
- Remove these settings from your VS Code `settings.json`:
177+
```json
178+
"markdown.preview.openMarkdownLinks": "inPreview",
179+
"workbench.editorAssociations": {
180+
"*.md": "vscode.markdown.preview.editor"
181+
}
182+
```
183+
- Temporarily disable markdown-related extensions to test if they're causing the issue
184+
- Restart VS Code after making these changes
185+
165186
### How do I report a bug or suggest a feature?
166187

167188
Please report bugs or suggest features on the Roo Code [Issues page](https://github.com/RooCodeInc/Roo-Code/issues) and [Feature Requests page](https://github.com/RooCodeInc/Roo-Code/discussions/categories/feature-requests?discussions_q=is%3Aopen+category%3A%22Feature+Requests%22+sort%3Atop).

docs/features/api-configuration-profiles.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Configuration profiles can have their own:
3232
- [Temperature settings](/features/model-temperature) for controlling response randomness
3333
- Thinking budgets
3434
- Provider-specific settings
35-
- Diff editing configuration
35+
- [Diff editing configuration](/features/fast-edits)
3636
- Rate limit settings
3737

3838
Note that available settings vary by provider and model. Each provider offers different configuration options, and even within the same provider, different models may support different parameter ranges or features.
@@ -111,5 +111,5 @@ API keys are stored securely in VSCode's Secret Storage and are never exposed in
111111
- Integrates with [local models](/advanced-usage/local-models) for offline work
112112
- Supports [temperature settings](/features/model-temperature) per mode
113113
- Supports per-profile rate limits (configured here) and general [usage tracking/cost info](/advanced-usage/rate-limits-costs)
114-
- Supports per-profile diff editing configuration (v3.12+) for tailored code editing behavior
114+
- Supports [Diff/Fast Edits](/features/fast-edits) for tailored code editing behavior.
115115

docs/features/fast-edits.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
1-
# Fast Edits
1+
# Diff/Fast Edits
22

33
:::info Default Setting
44
Fast Edits (using the "Enable editing through diffs" setting) is enabled by default in Roo Code. You typically don't need to change these settings unless you encounter specific issues or want to experiment with different diff strategies.
55
:::
66

77
Roo Code offers an advanced setting to change how it edits files, using diffs (differences) instead of rewriting entire files. Enabling this feature provides significant benefits.
88

9-
## Enable Editing Through Diffs
10-
11-
Open Settings by clicking the gear icon <Codicon name="gear" /> → Advanced
9+
:::note Per-Provider Setting
10+
Diff editing configuration is set per [API Configuration Profile](/features/api-configuration-profiles), allowing you to customize editing behavior for different providers and models.
11+
:::
1212

13+
## Enable Editing Through Diffs
1314

15+
Open the Roo Code pane settings by clicking the gear icon <Codicon name="gear" />. The `Providers` section will be visible. Select the specific [API Configuration Profile](/features/api-configuration-profiles) you want to configure.
1416

1517
When **Enable editing through diffs** is checked:
1618

17-
<img src="/img/fast-edits/fast-edits-5.png" alt="Roo Code settings showing Enable editing through diffs" width="500" />
19+
<img src="/img/fast-edits/fast-edits-2.png" alt="Roo Code settings showing Enable editing through diffs" width="500" />
1820
1. **Faster File Editing**: Roo modifies files more quickly by applying only the necessary changes.
1921
2. **Prevents Truncated Writes**: The system automatically detects and rejects attempts by the AI to write incomplete file content, which can happen with large files or complex instructions. This helps prevent corrupted files.
2022

72.2 KB
Loading

0 commit comments

Comments
 (0)