Skip to content

Commit 87c6fc8

Browse files
committed
docs: Add FAQ entry for issues writing to markdown files and provide troubleshooting steps
1 parent 20b7b7c commit 87c6fc8

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
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).

0 commit comments

Comments
 (0)