> ## Documentation Index
> Fetch the complete documentation index at: https://superwhisper-docs-cloud-model-rate-limits.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Report an Issue

> Learn how to get help when Superwhisper isn't working as expected

## Overview

This guide outlines the essential information needed to report issues effectively, ensuring quick and accurate solutions for any challenges you encounter with Superwhisper.

<Info>
  For quick support, reach out at [support@superwhisper.com](mailto:support@superwhisper.com). You can also share your issue in [Superwhisper's Discord server](https://discord.gg/tF98XvJNvB), under the appropriate channel. While our Discord community often provide helpful advice, email support typically offers the fastest path to resolving your issue.
</Info>

## Enable Error Reporting

<Steps>
  <Step title="Access Configuration">
    Navigate to the configuration page in Superwhisper settings
  </Step>

  <Step title="Enable Error Logging">
    Locate and enable the error log toggle switch

    <img style={{ borderRadius: '0.5rem' }} src="https://mintcdn.com/superwhisper-docs-cloud-model-rate-limits/pbQcuJvzOhF7n2dL/images/get-started/report-001.png?fit=max&auto=format&n=pbQcuJvzOhF7n2dL&q=85&s=8342a8f31eb5e29987c1e9c003317d79" alt="Superwhisper Error Logging" width="1728" height="1381" data-path="images/get-started/report-001.png" />
  </Step>
</Steps>

## Reporting Through History

The most effective way to report issues related to recordings, is directly through Superwhisper's history.

<Steps>
  <Step title="Access History">
    Click the menu icon in Superwhisper and select "History"

    <img style={{ borderRadius: '0.5rem' }} src="https://mintcdn.com/superwhisper-docs-cloud-model-rate-limits/pbQcuJvzOhF7n2dL/images/get-started/report-002.png?fit=max&auto=format&n=pbQcuJvzOhF7n2dL&q=85&s=b83f2056167a2b58af755e455beb3638" alt="Access Superwhisper History" width="1492" height="696" data-path="images/get-started/report-002.png" />
  </Step>

  <Step title="Submit Your Recording">
    Find the problematic recording in the left sidebar and right-click to select "Report Issue"

    <img style={{ borderRadius: '0.5rem' }} src="https://mintcdn.com/superwhisper-docs-cloud-model-rate-limits/pbQcuJvzOhF7n2dL/images/get-started/report-003.png?fit=max&auto=format&n=pbQcuJvzOhF7n2dL&q=85&s=d823f13ebe0b7503127a89711306a5fb" alt="Report Issue from Superwhisper History" width="2046" height="1106" data-path="images/get-started/report-003.png" />
  </Step>
</Steps>

## Manual Reporting via Email

As an alternative method you can submit issues manually via email. Here's what to include:

### Required Screenshots

<AccordionGroup>
  <Accordion title="Main Superwhisper Configuration">
    <img style={{ borderRadius: '0.5rem' }} src="https://mintcdn.com/superwhisper-docs-cloud-model-rate-limits/pbQcuJvzOhF7n2dL/images/get-started/report-004.png?fit=max&auto=format&n=pbQcuJvzOhF7n2dL&q=85&s=a9d12d9534abd36e6277379b6514e994" alt="Superwhisper Main Configuration" width="1744" height="1724" data-path="images/get-started/report-004.png" />
  </Accordion>

  <Accordion title="Active Mode Settings">
    <img style={{ borderRadius: '0.5rem' }} src="https://mintcdn.com/superwhisper-docs-cloud-model-rate-limits/pbQcuJvzOhF7n2dL/images/get-started/report-005.png?fit=max&auto=format&n=pbQcuJvzOhF7n2dL&q=85&s=abe864c3115e9ab32f2440b6e88e657d" alt="Superwhisper Mode Settings" width="1744" height="1610" data-path="images/get-started/report-005.png" />
  </Accordion>

  <Accordion title="Custom Mode Prompt Configuration">
    If you're using a Custom Mode, include a screenshot of your prompt configuration

    <img style={{ borderRadius: '0.5rem' }} src="https://mintcdn.com/superwhisper-docs-cloud-model-rate-limits/pbQcuJvzOhF7n2dL/images/get-started/report-006.png?fit=max&auto=format&n=pbQcuJvzOhF7n2dL&q=85&s=7f4d2f57df74b340455a93d27f783a0f" alt="Superwhisper Custom Mode Configuration" width="1834" height="1051" data-path="images/get-started/report-006.png" />
  </Accordion>
</AccordionGroup>

### Collecting Test Recording Data

<Steps>
  <Step title="Create Test Recording">
    Make a brief recording demonstrating the issue
  </Step>

  <Step title="Access History">
    From within the history panel, select the test recording and reveal its folder in Finder

    <img style={{ borderRadius: '0.5rem' }} src="https://mintcdn.com/superwhisper-docs-cloud-model-rate-limits/pbQcuJvzOhF7n2dL/images/get-started/report-007.png?fit=max&auto=format&n=pbQcuJvzOhF7n2dL&q=85&s=d314a033c0541174f5f873392459cdc2" alt="Reveal Recording in Finder" width="2043" height="1106" data-path="images/get-started/report-007.png" />
  </Step>

  <Step title="Compress and Send">
    Compress the selected folder and attach it to your email along with the screenshots

    <img style={{ borderRadius: '0.5rem' }} src="https://mintcdn.com/superwhisper-docs-cloud-model-rate-limits/pbQcuJvzOhF7n2dL/images/get-started/report-008.png?fit=max&auto=format&n=pbQcuJvzOhF7n2dL&q=85&s=c3ce20c6d9a61fba6652bae5163f944c" alt="Compress Recording Files" width="1356" height="860" data-path="images/get-started/report-008.png" />
  </Step>
</Steps>

***

<Note>
  Whichever method you choose, remember to provide a clear description of the issue and include any steps necessary to reproduce the problem.
</Note>