diff --git a/docs/reporting-errors.md b/docs/reporting-errors.md new file mode 100644 index 00000000..34c0470c --- /dev/null +++ b/docs/reporting-errors.md @@ -0,0 +1,60 @@ +--- +description: Learn how to report errors in Roo Code by accessing error details, copying diagnostic information, and sharing it with the support team. +keywords: + - error reporting + - error details + - troubleshooting + - support + - bug report + - diagnostics +image: /img/social-share.jpg +--- + +# Reporting Errors + +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. + +--- + +## Accessing Error Details + +When an error appears, click the "Details" link next to the error message. This opens a modal with diagnostic information and export options. + +Click Details link on error message to access diagnostic options + +*The Details link reveals two export options for sharing error information with support.* + +--- + +## Choosing the Right Export Option + +The Error Details modal offers two buttons, each serving different needs: + +1. **Copy basic error info** - Copies essential error details to your clipboard: + - Timestamp and extension version + - Provider and model being used + - The specific error message + + **Use when:** You want to quickly share the error in Discord or a brief support email. + +2. **Get detailed error info** - Opens a full diagnostic report with: + - Everything from basic info + - Complete task history showing all messages and actions + - Full configuration and environment details + - Provider-specific settings + + **Use when:** The support team needs to reproduce the issue or you're filing a GitHub issue. + +Error Details modal with Copy basic error info and Get detailed error info buttons + +--- + +## Sharing with Support + +After copying error information: + +- **Email**: Send to [support@roocode.com](mailto:support@roocode.com) +- **Discord**: Share in the [#support channel](https://discord.gg/roocode) +- **GitHub Issues**: File at [github.com/RooCodeInc/Roo-Code/issues](https://github.com/RooCodeInc/Roo-Code/issues) + +Include a brief description of what you were trying to do when the error occurred. The exported diagnostics handle the technical details. diff --git a/sidebars.ts b/sidebars.ts index 8d8bc89a..0eacd8d3 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -17,6 +17,7 @@ const sidebars: SidebarsConfig = { 'basic-usage/context-mentions', 'basic-usage/using-modes', 'tips-and-tricks', + 'reporting-errors', { label: 'Features', type: 'category', diff --git a/static/img/reporting-errors/reporting-errors-1.png b/static/img/reporting-errors/reporting-errors-1.png new file mode 100644 index 00000000..472b7e17 Binary files /dev/null and b/static/img/reporting-errors/reporting-errors-1.png differ diff --git a/static/img/reporting-errors/reporting-errors-2.png b/static/img/reporting-errors/reporting-errors-2.png new file mode 100644 index 00000000..9f3838ef Binary files /dev/null and b/static/img/reporting-errors/reporting-errors-2.png differ