Skip to content

Commit 0ee7398

Browse files
SannidhyaSannidhya
authored andcommitted
Add error reporting documentation with step-by-step guide
- Create new reporting-errors.md page explaining error details workflow - Add screenshots showing error message and Error Details modal UI - Document basic vs detailed export options with decision table - Include support contact channels (email, Discord, GitHub) - Add page to sidebar after tips-and-tricks
1 parent 7392238 commit 0ee7398

File tree

4 files changed

+89
-0
lines changed

4 files changed

+89
-0
lines changed

docs/reporting-errors.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
description: Learn how to report errors in Roo Code by accessing error details, copying diagnostic information, and sharing it with the support team.
3+
keywords:
4+
- error reporting
5+
- error details
6+
- troubleshooting
7+
- support
8+
- bug report
9+
- diagnostics
10+
image: /img/social-share.jpg
11+
---
12+
13+
# Reporting Errors
14+
15+
When Roo Code encounters an error, you can export detailed diagnostic information to share with the support team. This helps resolve issues faster by providing complete context about what went wrong.
16+
17+
---
18+
19+
## Why It Matters
20+
21+
Error reports with full diagnostic data cut resolution time dramatically. Instead of back-and-forth questions about your setup, extension version, or what you were doing, the support team gets everything they need in one go. The detailed export includes your full task history, configuration, and environment—critical for reproducing and fixing issues.
22+
23+
---
24+
25+
## Accessing Error Details
26+
27+
When an error appears, click the "Details" link next to the error message. This opens a modal with diagnostic information and export options.
28+
29+
<img src="/img/reporting-errors/reporting-errors-1.png" alt="Click Details link on error message to access diagnostic options" width="600" />
30+
31+
*The Details link reveals two export options for sharing error information with support.*
32+
33+
---
34+
35+
## Choosing the Right Export Option
36+
37+
The Error Details modal offers two buttons, each serving different needs:
38+
39+
1. **Copy basic error info** - Copies essential error details to your clipboard:
40+
- Timestamp and extension version
41+
- Provider and model being used
42+
- The specific error message
43+
44+
**Use when:** You want to quickly share the error in Discord or a brief support email.
45+
46+
2. **Get detailed error info** - Opens a full diagnostic report with:
47+
- Everything from basic info
48+
- Complete task history showing all messages and actions
49+
- Full configuration and environment details
50+
- Provider-specific settings
51+
52+
**Use when:** The support team needs to reproduce the issue or you're filing a GitHub issue.
53+
54+
<img src="/img/reporting-errors/reporting-errors-2.png" alt="Error Details modal with Copy basic error info and Get detailed error info buttons" width="600" />
55+
56+
*Choose basic for quick reports or detailed for thorough diagnostics.*
57+
58+
---
59+
60+
## Sharing with Support
61+
62+
After copying error information:
63+
64+
- **Email**: Send to [[email protected]](mailto:[email protected])
65+
- **Discord**: Share in the [#support channel](https://discord.gg/roocode)
66+
- **GitHub Issues**: File at [github.com/RooCodeInc/Roo-Code/issues](https://github.com/RooCodeInc/Roo-Code/issues)
67+
68+
Include a brief description of what you were trying to do when the error occurred. The exported diagnostics handle the technical details.
69+
70+
---
71+
72+
## What You Can't Do
73+
74+
Error exports don't include your actual code or file contents—only metadata about the task. If the support team needs to see specific code that triggered the error, you'll need to share that separately.
75+
76+
---
77+
78+
## When to Use Each Option
79+
80+
| Scenario | Use This |
81+
|----------|----------|
82+
| Quick question in Discord | **Copy basic error info** |
83+
| Filing a GitHub issue | **Get detailed error info** |
84+
| Support email for recurring error | **Get detailed error info** |
85+
| Asking about a specific error message | **Copy basic error info** |
86+
| Error that only happens in certain conditions | **Get detailed error info** |
87+
88+
The detailed report's task history helps the team understand the sequence of events leading to the error—invaluable for intermittent or complex issues.

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ const sidebars: SidebarsConfig = {
1717
'basic-usage/context-mentions',
1818
'basic-usage/using-modes',
1919
'tips-and-tricks',
20+
'reporting-errors',
2021
{
2122
label: 'Features',
2223
type: 'category',
24.9 KB
Loading
73.3 KB
Loading

0 commit comments

Comments
 (0)