Skip to content

Updates on Mini and Interface #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified .DS_Store
Binary file not shown.
2 changes: 1 addition & 1 deletion common-issues/unable-to-create-mode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Follow these steps to redirect Superwhisper to the correct folder location:

<Steps>
<Step title="Open the Configuration Tab">
Access the Configuration section from the left sidebar menu in Superwhisper and toggle on the "Advanced Settings."
Access the Configuration section from the left sidebar menu in Superwhisper and go to "Advanced Settings."
<img style={{ borderRadius: '0.5rem' }} src="/images/common-issues/unable-to-create-mode-001.png" alt="Configuration tab in Superwhisper" />
</Step>

Expand Down
1 change: 0 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@
"get-started/interface-menu-bar",
"get-started/interface-rec-window",
"get-started/interface-ai-models",
"get-started/interface-replacements",
"get-started/interface-vocabulary",
"get-started/interface-history"
]
Expand Down
9 changes: 9 additions & 0 deletions get-started/interface-history.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ You can access Superwhisper's history through:
alt="Accessing Superwhisper History from menu bar"
/>
</Accordion>

<Accordion title="3. Mini Recording Window Context Menu">
<img
style={{ borderRadius: '0.5rem' }}
src="/images/get-started/interface-history-012.png" noZoom
alt="Accessing Superwhisper History from mini recording window"
/>
</Accordion>

</AccordionGroup>

---
Expand Down
3 changes: 2 additions & 1 deletion get-started/interface-menu-bar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ The menu bar icon features a color-coded dot that indicates the current status o
</Step>
<Step title="Application Controls">
- Open main settings window
- Change input device
- Change active mode
- Check for updates
- Quit application
Expand All @@ -62,7 +63,7 @@ The Superwhisper menu bar icon provides two main interaction modes:
Clicking the icon opens the menu with all available options
</Step>
<Step title="Quick Recording">
You can enable this in the [advanced settings](settings-advanced#interface-customization). This setting changes the default behavior to:
You can enable this in the [advanced settings](settings-advanced#application). This setting changes the default behavior to:
- Left click toggles recording
- Right click opens the full menu
</Step>
Expand Down
102 changes: 72 additions & 30 deletions get-started/interface-rec-window.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,20 @@ description: "Learn how to identify and utilize the key features of the Superwhi
## Overview
Superwhisper's recording window is carefully designed to provide intuitive control and real-time feedback during your dictation.

**Let's explore the seven essential components of this powerful interface:**
**Let's explore the key components of the main recording interface:**

---
## 1. Resize Toggle
## Main Recording Window
### 1. Resize Toggle

<img
style={{ borderRadius: '0.5rem'}}
src="/images/get-started/interface-rec-window-002.png"
alt="Superwhisper Resize Toggle"
/>
When you hover over the recording window, you can click here to switch between a large and mini view.
When you hover over the recording window, you can click here to switch between the main and mini view.

<Accordion title="Mini View" icon="microphone-lines" defaultOpen="true">
The mini view simplifies your recording experience by displaying only essential features like the waveform and status indicator. This compact interface lets you focus on dictation without distractions.

<img
style={{ borderRadius: '0.5rem'}} noZoom
src="/images/get-started/interface-rec-window-003.png"
alt="Superwhisper Mini Recording Window"
/>

</Accordion>

---
## 2. Audio Waveform
### 2. Audio Waveform

<img
style={{ borderRadius: '0.5rem'}}
Expand All @@ -52,8 +41,7 @@ If the waveform stays static, check these elements:

<Note>Exception: When using [system audio capture in a Custom mode](../modes/custom#audio-options), the waveform remains static. Your audio still records properly - you can verify this in the [History tab](interface-history), which displays detailed information about each dictation session.</Note>

---
## 3. Status Indicator
### 3. Status Indicator

<img
style={{ borderRadius: '0.5rem'}}
Expand All @@ -66,8 +54,7 @@ The color-coded dot reflects the current recording status, similar to the one in
- Blue: Dictation processing
- Green: Processing completed

---
## 4. Mode Display
### 4. Mode Display

<img
style={{ borderRadius: '0.5rem'}}
Expand All @@ -81,20 +68,17 @@ This area of the recording window shows your currently active mode in Superwhisp
In Super Mode, this area displays your current application or website context.
</Info>


---
## 5. Context Capture
### 5. Context Capture

<img
style={{ borderRadius: '0.5rem'}}
src="/images/get-started/interface-rec-window-007.png"
alt="Superwhisper Context Capture Indicator"
/>

This indicator can appear in Super Mode or Custom modes with context awareness features enabled. It lights up to confirm Superwhisper has captured clipboard context - when you copy text within 3 seconds before dictation starts or during an active dictation session. Additionally, it signals when selected text context is captured at the exact moment recording begins.
This indicator can appear in Super Mode or Custom modes with [context awareness features](../common-issues/context) enabled. It lights up to confirm Superwhisper has captured clipboard context - when you copy text within 3 seconds before dictation starts or during an active dictation session. Additionally, it signals when selected text context is captured at the exact moment recording begins.

---
## 6. Stop Recording
### 6. Stop Recording

<img
style={{ borderRadius: '0.5rem'}}
Expand All @@ -104,8 +88,7 @@ alt="Stop Superwhisper's dictation"

If you're ready to wrap up your dictation, click here to stop recording - or use the same keyboard shortcut you used to start.

---
## 7. Cancel Dictation
### 7. Cancel Dictation

<img
style={{ borderRadius: '0.5rem'}}
Expand All @@ -116,13 +99,72 @@ alt="Cancel Superwhisper's dictation"
Click here to cancel your current dictation session or use your assigned keyboard shortcut. For recordings longer than 30 seconds, Superwhisper displays a confirmation message to prevent accidental cancellations. Recordings under 30 seconds cancel immediately.

---
## Mini Recording Window

The mini recording window provides a compact yet feature-rich interface for controlling Superwhisper.

### Always-Active Mini Window

[In Advanced Settings](settings-advanced#recording-window), you can configure the mini window to remain active even when idle. This creates a small visual indicator that's always accessible.

<Steps>
<Step title="Hover Over the Indicator">
When you hover over the mini window indicator, a control panel appears with three options:
1. Change Mode
2. Start Recording
3. Expand to Regular Window

<img
style={{ borderRadius: '0.5rem'}}
src="/images/get-started/interface-rec-window-010.png"
alt="Superwhisper Mini Window on Hover"
/>

</Step>
<Step title="Post-Request Controls">
These same controls (Change Mode, Start Recording, Expand) also appear after a dictation request completes, particularly when results aren't automatically pasted to the front application.

<img
style={{ borderRadius: '0.5rem'}}
src="/images/get-started/interface-rec-window-011.png"
alt="Superwhisper Mini Window with Resuls"
/>

</Step>
</Steps>

### Recording with the Mini Window
You can start recording either by:
- Clicking the recording button in the mini window
- Using your standard keyboard shortcut

During recording, the mini window displays audio waveforms similar to the main window (1). When you hover over the mini window while recording (2), a stop button appears to end the recording and begin processing.

<img
style={{ borderRadius: '0.5rem'}}
src="/images/get-started/interface-rec-window-012.png"
alt="Superwhisper Mini Window During Recording"
/>


### Additional Mini Window Features

<Tip>
Right-click on the mini window to access a context menu with options to:
- Expand Window
- Open Settings
- Open History

These options are also available during active recording sessions.
</Tip>

## Related Documentation

<CardGroup cols={2}>
<Card title="Advanced Settings" icon="sliders" href="settings-advanced">
Superwhisper can operate using menu bar indicators alone, without the recording window. Learn how to customize these and more settings.
Learn how to customize the mini window behavior and other Superwhisper settings.
</Card>
<Card title="Context Awareness" icon="brain-circuit" href="../modes/super#context-awareness">
<Card title="Context Awareness" icon="brain-circuit" href="../common-issues/context">
Discover how Superwhisper's context awareness features superpower your dictation. These features help AI understand your needs and deliver smarter, more accurate results.
</Card>
</CardGroup>
60 changes: 42 additions & 18 deletions get-started/interface-vocabulary.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Vocabulary"
description: "Learn how the Vocabulary feature in Superwhisper improves AI voice transcription accuracy by allowing users to add custom words, acronyms, or company names."
description: "Improve AI transcription accuracy in Superwhisper by adding custom vocabulary and automatic text replacements for specialized terms and corrections."
---

<img
Expand All @@ -11,22 +11,27 @@ description: "Learn how the Vocabulary feature in Superwhisper improves AI voice

## Overview

Vocabulary is a specialized AI feature in Superwhisper that helps improve transcription accuracy by providing custom word recognition during the AI transcription process.
The Vocabulary feature in Superwhisper provides two powerful tools to improve your dictation experience: vocabulary words for better AI transcription recognition, and replacements for consistent post-transcription corrections.

---
## How it Works
When you add words to the Vocabulary tab, you're essentially providing the AI transcription model with:

## Vocabulary Words

### How Vocabulary Words Work

When you add words to the vocabulary section, you're providing the AI transcription model with custom recognition hints during the transcription process. These words are sent alongside your audio to help the AI recognize and accurately transcribe:

- Custom words
- Acronyms
- Acronyms
- Company names
- People's names
- Specialized terminology
- Words from other languages

These words are sent alongside the audio to help the AI recognize and accurately transcribe specific terms.
### Important Considerations for Vocabulary

---
## Important Considerations
While the vocabulary feature can be helpful, it should be used sparingly to avoid potential transcription complications:

While the Vocabulary feature can be helpful, it should be used sparingly to avoid potential transcription complications.
- Adding too many words can confuse the AI transcription model
- Words in different languages might impact transcription accuracy
- The feature influences not just spelling, but potentially:
Expand All @@ -35,15 +40,34 @@ While the Vocabulary feature can be helpful, it should be used sparingly to avoi
- Overall formatting

<Tip>
**Recommended approach:** Use Vocabulary minimally and complement it with the [Replacements](interface-replacements) feature for more consistent results.
**Recommended approach:** Use vocabulary words minimally and complement them with replacements for more consistent results.
</Tip>

---
## Using the Vocabulary Tab
<img
style={{ borderRadius: '0.5rem' }}
src="/images/get-started/interface-vocabulary-002.png"
alt="How to Use Superwhisper Vocabulary"
/>
1. To add a new vocabulary word, simply type your word in the field and select "Create".
2. To remove a vocabulary word, select the bin/trash icon next to the word to remove it.

## Replacements

### How Replacements Work

Replacements operate at the post-transcription stage of processing. Once your voice input is transcribed into text, any replacements you've configured will be automatically applied. This step is performed programmatically and does not rely on AI interpretation, ensuring that replacements happen exactly as you define them.

<Info>
Replacements match words regardless of capitalization. The matching system is case-insensitive, so "todo" will match "ToDo", "TODO", or "Todo". The replaced output will appear in the exact case you have specified for the replacement.
</Info>

### When to Use Replacements

Replacements are the recommended solution for correcting persistent errors or expanding frequently used phrases. Because this feature operates independently of AI, the results are consistent and immediate, regardless of how the transcription model performs.

<Check>
If you notice that certain words are consistently mis-transcribed, you can add multiple replacements to address every variation and point them all to the correct result.
</Check>

---

## Vocabulary Management

Both vocabulary words and replacements can be managed from the same interface:

- To remove any item, select the bin/trash icon next to it
- You can mix vocabulary words and replacements based on your specific needs
2 changes: 1 addition & 1 deletion get-started/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Instantly turn speech into perfect emails, crisp notes, clear messages, professi
</Accordion>

<Accordion title="Unlimited AI">
Experience unlimited access to powerful cloud & local AI models including OpenAI GPT-4o, Anthropic Claude 3.5 Sonnet, Deepgram Nova 2, Groq Llama 3.1, and more. Process dictations with state-of-the-art language models without worrying about usage limits or additional costs.
Experience unlimited access to powerful cloud & local AI models from leading providers like OpenAI, Anthropic, Deepgram, and Groq. Process dictations with advanced language models without worrying about usage limits or additional costs.
</Accordion>
</AccordionGroup>

Expand Down
36 changes: 28 additions & 8 deletions get-started/settings-advanced.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,27 @@ description: "Superwhisper's advanced configuration options let you modify appli

Superwhisper's advanced configuration options let you modify application behavior, adjust performance settings, and manage system-level preferences for a personalized dictation experience.

## Recording Window
<img
style={{ borderRadius: '0.5rem' }}
src="/images/get-started/settings-advanced-006.png"
alt="Superwhisper Recording Window Options"
/>

### Recording Window Enabled
If you prefer to stay focused on your work without visual distractions, you can disable the recording window. Audio cues will still notify you when recording starts and when processing completes.

### Auto-Close Window
By default, with recording window and paste result enabled, the window closes only after successful paste detection. Enable this setting to automatically close the Recording Window after every dictation, regardless of paste status. Your dictated text remains in the clipboard for manual pasting if needed.

### Mini Recording Window
Use the mini recording window by default. You can switch between the mini and regular recording window anytime [through the interface](interface-rec-window).

### Always show Mini Recording Window
If enabled, you will always have a minimal visual indicator that allows you to hover over it to start recording, switch modes, or open the larger recording window.

---
## Interface Customization
## Application
<img
style={{ borderRadius: '0.5rem' }}
src="/images/get-started/settings-advanced-002.png"
Expand All @@ -24,25 +43,23 @@ Control whether Superwhisper appears in your dock for quick access
### Start Recording on Menubar Click
Enabling this toggle will allow you to start or stop your recording by clicking on the menu icon. If you want to access the regular options from the menu bar icon, you will just simply right click on it.

### Recording Window Enabled
If you prefer to stay focused on your work without visual distractions, you can disable the recording window. Audio cues will still notify you when recording starts and when processing completes.

### Auto-Close Window
By default, with recording window and paste result enabled, the window closes only after successful paste detection. Enable this setting to automatically close the Recording Window after every dictation, regardless of paste status. Your dictated text remains in the clipboard for manual pasting if needed.

---
## Voice Processing Options
<img
style={{ borderRadius: '0.5rem' }}
src="/images/get-started/settings-advanced-003.png"
alt="Superwhisper Voice Processing Options"
/>

### Voice Model Active Duration
Adjust the active duration of voice processing to balance between speed and resource usage. Higher durations keep the AI model loaded in system memory, enabling faster initial processing but reducing available resources for other applications. Lower durations free up system memory but may require additional time when starting new dictation sessions.

### Silence Removal
Silence removal helps you get better transcripts and faster results by skipping quiet parts in your audio. Additionally, this feature is helpful in the prevention of AI hallucinations during silent moments. If you see text you never said in your transcripts, turning on silence removal may fix this by stopping the AI from trying to make sense of silence.

### Dynamic Normalization
When enabled, recordings are automatically normalized and filtered to maintain consistent loudness levels. This feature helps ensure your voice is clearly recognized across all recordings, regardless of variations in microphone distance or ambient conditions.

---
## Folder Location
<img
Expand All @@ -54,9 +71,12 @@ Silence removal helps you get better transcripts and faster results by skipping
Superwhisper keeps configuration files in your Documents folder by default. This folder stores your history files, your custom modes settings, vocabulary, and text replacements. **Creating a backup of this folder is recommended if you want to preserve your personalized configurations or transfer them to a new machine.**

<Note>
Since Superwhisper actively uses this folder during dictation, ensure it remains locally accessible on your device. If using iCloud sync for your Documents folder, verify that this specific folder remains local to prevent operational issues.
Since Superwhisper actively uses this folder during dictation, it is suggested for this folder to remains locally accessible on your device.
</Note>

### Filesync
When you enable this option, your Superwhisper configuration files will automatically sync across all installations registered under the same license.

---
## Text Processing Controls
<img
Expand Down
Loading