diff --git a/docs/Basic Usage/basic_usage.md b/docs/Basic Usage/basic_usage.md
index 88b034d8..e60fa310 100644
--- a/docs/Basic Usage/basic_usage.md
+++ b/docs/Basic Usage/basic_usage.md
@@ -31,7 +31,7 @@ To keep track of what mode you are in with a visual icon, enable the [mode indic
| `help next`, `help previous` | go to the next or previous page of help items if there are a lot |
| `help close` | hide any open help window again |
| `command history` | show the command history |
-| `talon open log` | open the talon log for debugging |
+| `talon open log` | open the Talon log for debugging |
## Dictating Text
@@ -102,9 +102,9 @@ These commands will open up a CSV or [Talon list](Customization/talon_lists.md)
| Command | Description |
| -------------- | ------------------------------------------------------------------------- |
| `copy that` | |
-| `control cap` | copy via the keyboard shortcut using the talon alphabet (`cap` for `c`) |
+| `control cap` | copy via the keyboard shortcut using the Talon alphabet (`cap` for `c`) |
| `paste that` | |
-| `control vest` | paste via the keyboard shortcut using the talon alphabet (`vest` for `v`) |
+| `control vest` | paste via the keyboard shortcut using the Talon alphabet (`vest` for `v`) |
| `cut that` | |
| `undo that` | |
| `redo that` | |
diff --git a/docs/Basic Usage/settings.md b/docs/Basic Usage/settings.md
index 8b1122d3..fa4c6b71 100644
--- a/docs/Basic Usage/settings.md
+++ b/docs/Basic Usage/settings.md
@@ -3,7 +3,7 @@
Talon's behavior can be changed by changing the value of settings within a `.talon` file inside a `settings():` block.
```talon
-# Example talon file
+# Example Talon file
settings():
# Enable the Talon mode indicator
user.mode_indicator_show = true
@@ -49,11 +49,11 @@ If the same setting is defined multiple times, Talon will use the setting value
| Setting | Example Value | Description |
| --------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| imgui.scale | 1.5 | Adjust the scale of the imgui windows |
-| imgui.dark_mode | false | If `true` enable dark mode for talon imgui menus (used for help menus in community) |
+| imgui.dark_mode | false | If `true` enable dark mode for Talon imgui menus (used for help menus in community) |
| insert_wait | 0 | Increase this if characters seem to be jumbled in a specific app when typing whole sentences. Default is 0. |
| key_hold | 16 | Increase this if you're playing a game and some keys aren't registering at all. You should probably increase it in 16ms increments, e.g. set it to 16ms or 32ms. |
| key_wait | 1 | Increase this if modifier keys are getting dropped or if key presses are misbehaving even with the other two settings (`insert_wait` and `key_hold`) tuned. `key_wait` should be the last resort because it results in the slowest overall keypress rate. Default is 1.0 in milliseconds. |
-| speech.engine | | Determines which [speech engine](../Quickstart/Speech%20Engines/speech%20engines.md) talon uses to recognize input. This is useful for configuring dictation mode to use a different speech engine; for example, 'webspeech'. |
+| speech.engine | | Determines which [speech engine](../Resource%20Hub/Speech%20Recognition/speech%20engines.md) Talon uses to recognize input. This is useful for configuring dictation mode to use a different speech engine; for example, 'webspeech'. |
| speech.timeout | | This determines how long a pause Talon waits for before deciding you've finished speaking and interpreting what you've just said as a sequence of commands. This parameter is generally very important; for example, it determines the amount of time you can pause between saying 'phrase' and the following phrase. It is measured in seconds; the default is 0.300, i.e. 300 milliseconds. |
To add your own additional custom settings for changing Talon behavior, see [the settings customization page](../Customization/Talon%20Framework/settings.md)
diff --git a/docs/Customization/Talon Framework/lists.md b/docs/Customization/Talon Framework/lists.md
index 8eafb3f5..d2712ecf 100644
--- a/docs/Customization/Talon Framework/lists.md
+++ b/docs/Customization/Talon Framework/lists.md
@@ -56,7 +56,7 @@ Because list contents can only be replaced in their entirety, end users can have
### Dynamic Lists
-Dynamic lists are an advanced Talon feature that as of Talon 0.4 are currently **beta-only**. They are used for generating lists of items for voice commands at runtime. For example, you can use dynamic lists to create voice commands specific to the names of elements currently on the screen. Without dynamic lists you would otherwise have to poll and constantly update a normal talon list. Dynamic lists can also return [selection lists](#selection-lists) to dynamically match voice commands to substrings.
+Dynamic lists are an advanced Talon feature that as of Talon 0.4 are currently **beta-only**. They are used for generating lists of items for voice commands at runtime. For example, you can use dynamic lists to create voice commands specific to the names of elements currently on the screen. Without dynamic lists you would otherwise have to poll and constantly update a normal Talon list. Dynamic lists can also return [selection lists](#selection-lists) to dynamically match voice commands to substrings.
If you do not need the list to be constructed during the voice command, you should use a regular Talon list instead.
diff --git a/docs/Customization/basic_customization.md b/docs/Customization/basic_customization.md
index b85f469e..d6e3efb7 100644
--- a/docs/Customization/basic_customization.md
+++ b/docs/Customization/basic_customization.md
@@ -4,7 +4,7 @@ sidebar_position: 1
# Basic customization
-Once you have successfully [set up Talon](../Quickstart/getting_started.md) you may find that you would like to change some of how it behaves at a basic level.
+Once you have successfully [set up Talon](../Resource%20Hub/Talon%20Installation/installation_guide) you may find that you would like to change some of how it behaves at a basic level.
## Customization overview
@@ -164,7 +164,7 @@ You might have noticed that we've been using the key() and insert() actions in t
1. Right click on the Talon icon in your status bar, choose scripting, and then 'Console (REPL)'. This will open a terminal window where you type Python commands and the results of those commands are printed out.
2. Type `actions.list()` and press enter. This will list out all the available actions.
-3. You might like to look at this list of actions in your text editor (so you can search them, for example). To put the full list into your clipboard, copy and paste this code into the talon console and press enter:
+3. You might like to look at this list of actions in your text editor (so you can search them, for example). To put the full list into your clipboard, copy and paste this code into the Talon console and press enter:
```python
import io;old=sys.stdout;sys.stdout = io.StringIO();actions.list();clip.set_text(sys.stdout.getvalue());sys.stdout = old
diff --git a/docs/Customization/talon-files.md b/docs/Customization/talon-files.md
index 714adab3..b96fdebe 100644
--- a/docs/Customization/talon-files.md
+++ b/docs/Customization/talon-files.md
@@ -4,7 +4,7 @@ sidebar_position: 2
# `.talon` Files
-The primary way to extend talon is using `.talon` files placed anywherein the `user` directory. A talon file comes in two parts
+The primary way to extend Talon is using `.talon` files placed anywhere in the `user` directory. A Talon file comes in two parts:
- A [context header](#context-header) defining the circumstances in which the file is active
- A body that implements various behaviors within that context which can:
@@ -55,7 +55,7 @@ The following requirements can be set:
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `os` | require specific operating systems; currently either `linux`, `mac`, or `windows` |
| `tag` | require a specific tag |
-| `mode` | only active for specific talon modes (like `command`, `dictation`, `sleep` et al.) |
+| `mode` | only active for specific Talon modes (like `command`, `dictation`, `sleep` et al.) |
| `app` | match applications by explicitly declared, well-known name |
| `app.name` | match applications by name (TODO where does Talon read this out?) |
| `app.exe` | match applications by executable, like `/usr/lib/firefox/firefox` or `firefox.exe` |
diff --git a/docs/Quickstart/FAQ.md b/docs/Help/FAQ.md
similarity index 75%
rename from docs/Quickstart/FAQ.md
rename to docs/Help/FAQ.md
index 01c31f78..229a5974 100644
--- a/docs/Quickstart/FAQ.md
+++ b/docs/Help/FAQ.md
@@ -14,25 +14,25 @@ Talon does not require special configuration for different programming languages
### What hardware should I have?
-Check out the [hardware](./Hardware/hardware.md) page for microphone and eye tracker recommendations.
+Check out the [hardware](../Resource%20Hub/Hardware/hardware.md) page for microphone and eye tracker recommendations.
### Are languages other than English supported?
They're being worked on, join [Talon Slack](https://talonvoice.com/chat) and find a channel for your language to see how it's going. If you are in the beta program, you can configure the WebSpeech API for dictation in other languages.
-### How can I make talon recognise me better?
+### How can I make Talon recognise me better?
-See the page [Improving Recognition Accuracy](improving_recognition_accuracy).
+See the page [Improving Recognition Accuracy](../Resource%20Hub/Speech%20Recognition/improving_recognition_accuracy).
### How can I contribute?
While Talon is closed source, there's plenty you can do to help:
- https://speech.talonvoice.com/ Extend the voice data set used for speech recognition training.
-- Publish your talon commands on Github for others to share. Consider contributing back to the [Talon Community](https://github.com/talonhub/community) user file set. Publicly shared file sets are [searchable using this search engine](https://search.talonvoice.com/search/).
+- Publish your Talon commands on Github for others to share. Consider contributing back to the [Talon Community](https://github.com/talonhub/community) user file set. Publicly shared file sets are [searchable using this search engine](https://search.talonvoice.com/search/).
- Report issues at https://github.com/talonvoice/talon/issues
- Add more to these docs :)
### Troubleshooting
-Checkout the [troubleshooting](troubleshooting) for solutions to common problems.
+The [Troubleshooting](../Resource%20Hub/Speech%20Recognition/troubleshooting) page includes solutions to common problems.
diff --git a/docs/Quickstart/beta_talon.md b/docs/Help/beta_talon.md
similarity index 100%
rename from docs/Quickstart/beta_talon.md
rename to docs/Help/beta_talon.md
diff --git a/docs/Help/talon-slack.md b/docs/Help/talon-slack.md
new file mode 100644
index 00000000..83736c6d
--- /dev/null
+++ b/docs/Help/talon-slack.md
@@ -0,0 +1,11 @@
+# Talon Slack
+
+Talon has a Slack community for users to get help, ask questions, and meet one another. If you are starting to use Talon, join the [Talon Slack](https://talonvoice.com/chat). This is the most efficient way to get questions answered if they are not covered in this wiki. There are also a few general channels, like `#health`, for those looking for resources and other folks who might be navigating complex injuries like RSI (Repetitive Strain Injuries) from typing.
+
+A few notable channels:
+
+- `#help`: get help with Talon setup, usage, or ask questions about Talon
+- `#beta`: find beta download links and ask questions specific to the beta (this is a private channel that requires a [Patreon donation](https://www.patreon.com/join/lunixbochs))
+- `#health`: chat with others about computer health issues, share knowledge, find other folks who might be going through similar things
+- `#talon-docs`: chat about Talon documentation such as this wiki
+- `#hardware`: chat about hardware, e.g., microphones
diff --git a/docs/Quickstart/Accessibility/non-visual-use.md b/docs/Integrations/accessibility.md
similarity index 78%
rename from docs/Quickstart/Accessibility/non-visual-use.md
rename to docs/Integrations/accessibility.md
index 841ee463..491f40eb 100644
--- a/docs/Quickstart/Accessibility/non-visual-use.md
+++ b/docs/Integrations/accessibility.md
@@ -1,18 +1,23 @@
-# Non-Visual Use
+---
+sidebar_position: 10
+---
+
+# Accessibility
+
+## Non-Visual Use
Although Talon is not explicitly designed for non-visual use, it can still be used well alongside screen readers or other assistive technology.
Please note that Talon is in rapid development and is largely community supported. If you have issues, please join the [community slack](https://talonvoice.com/chat) and let someone know.
-## How to get started
+### How to get started
-- Setup Talon according to the standard [quickstart](../getting_started.md)
- - Install Talon
- - Install a speech recognition engine
+- Setup Talon as per normal:
+ - [Install Talon](../Resource%20Hub/Talon%20Installation/installation_guide) and a speech recognition engine
- Install the [community user file set](https://github.com/talonhub/community)
- Once setup, install [sight-free-talon](https://github.com/C-Loftus/sight-free-talon). This repository provides text-to-speech integration for Talon. If you use a screen reader, this repo prevents Talon from interrupting the text-to-speech voice as it types characters during dictation.
- See the documentation in that repo for specific setup instructions
-## Limitations
+### Limitations
- Certain windows produced by Talon's imgui library, like those from the `help scope` command are not accessible.
diff --git a/docs/Integrations/essential-tools.md b/docs/Integrations/essential-tools.md
index 63aa4578..a3fa1b1e 100644
--- a/docs/Integrations/essential-tools.md
+++ b/docs/Integrations/essential-tools.md
@@ -1,3 +1,7 @@
+---
+sidebar_position: 1
+---
+
# Essential Talon Integrations
| Software | Description |
diff --git a/docs/Integrations/talon_related_resources.md b/docs/Integrations/talon_related_resources.md
index e579a9cb..5f5d1997 100644
--- a/docs/Integrations/talon_related_resources.md
+++ b/docs/Integrations/talon_related_resources.md
@@ -20,12 +20,12 @@ These videos/channels demonstrate some of the possibilities of Talon without rea
- [Ryan's Eye Tracking Demo](https://youtu.be/VMNsU7rrjRI) Demonstration of mouse control using eye tracking and Zoom mouse.
- [2Shea's Emoji Searching Demo](https://youtu.be/RA0idiJkZOg) Experienced user of Talon dictating code
- [2Shea's Mojolicious Perl App using Talon](https://youtu.be/X6rsA0Svh2M) More experienced code dictation
-- [talon rpi ether local w2l](https://youtu.be/PK6G1foW2Ao) Using Talon on a tablet. Channel has several videos.
+- [Talon rpi ether local w2l](https://youtu.be/PK6G1foW2Ao) Using Talon on a tablet. Channel has several videos.
## Text based educational resources
- [Matt's Visual TalonScript Builder](https://visual-talonscript.pages.dev) This is a web application that helps you build custom Talon commands with a visual interface.
- [Guenther Schmitz's Wiki of Talon configuations, issues, and solutions.](https://wiki.gpunktschmitz.com/index.php/Talon) This list contains a grab-bag of various configurations, answers to questioms, and solutions. Well worth looking at.
-- [chaosparrot's talon practice website:](https://chaosparrot.github.io/talon_practice) a website with games and lessions to help you practice basic Talon commands.
+- [chaosparrot's Talon practice website:](https://chaosparrot.github.io/talon_practice) a website with games and lessions to help you practice basic Talon commands.
- [Xevs web-based Talon Cheatsheet](https://talon-knausj-cheatsheet.netlify.app/) An online way to look up commands.
- [Stolen Sugar](https://www.stolensugar.com/) Explore alternative keywords for commands in the [Talon Community](https://github.com/talonhub/community) user file set.
diff --git a/docs/Integrations/talon_user_file_sets.md b/docs/Integrations/talon_user_file_sets.md
index 0350d16c..70e3ca5c 100644
--- a/docs/Integrations/talon_user_file_sets.md
+++ b/docs/Integrations/talon_user_file_sets.md
@@ -4,7 +4,7 @@ The main Talon user file set for Talon is [Talon Community](https://github.com/t
If intended for public consumption, these Talon user file sets are mostly annouced via the [Slack channel](https://talonvoice.com/chat). Aside from that there are a few ways you can discover them:
-- You can make use of the [talon code search](https://search.talonvoice.com/search/). This aims to search all known github repositories containing Talon related code. If you're looking for integration with a particular application this is a good option.
+- You can make use of the [Talon code search](https://search.talonvoice.com/search/). This aims to search all known github repositories containing Talon related code. If you're looking for integration with a particular application this is a good option.
- You can browse the [github talonvoice topic](https://github.com/topics/talonvoice). Repositories can optionally tag themselves with this to aid discoverability.
- You can take a look at the manually curated list below.
diff --git a/docs/Quickstart/Accessibility/_category_.yml b/docs/Quickstart/Accessibility/_category_.yml
deleted file mode 100644
index c1d74a49..00000000
--- a/docs/Quickstart/Accessibility/_category_.yml
+++ /dev/null
@@ -1 +0,0 @@
-position: 8 # float position is supported
diff --git a/docs/Quickstart/Speech Engines/_category_.yml b/docs/Quickstart/Speech Engines/_category_.yml
deleted file mode 100644
index 3b0fd414..00000000
--- a/docs/Quickstart/Speech Engines/_category_.yml
+++ /dev/null
@@ -1 +0,0 @@
-position: 4
diff --git a/docs/Quickstart/getting_started.md b/docs/Quickstart/getting_started.md
deleted file mode 100644
index 5b57bc3f..00000000
--- a/docs/Quickstart/getting_started.md
+++ /dev/null
@@ -1,47 +0,0 @@
----
-sidebar_position: 1
----
-
-# Getting Started
-
-:::note
-
-You can also install and run Talon by following the [official installation instructions](https://talonvoice.com/docs/). This info supplements that page.
-
-:::
-
-## 1: [Download Talon](https://talonvoice.com/)
-
-
- Notes for Linux Users
- - Talon, like many tools for automation or accessibility, __does not support Wayland__
- - You will have to select an X11 session from your login manager.
- - This is supported by Gnome and Plasma and many others, but some environments like sway are explicitly Wayland-only.
-- To install the speech engine, you must use Talon's tray icon:
- * If you use stock Gnome, you need to install [AppIndicator and KStatusNotifierItem Support](https://extensions.gnome.org/extension/615/appindicator-support/) to see it
- * If you use i3 or a system tray that doesn't support the `StatusNotifierItem` protocol, install [snixembed](https://git.sr.ht/~steef/snixembed) to add support.
-
-
-
-## 2: Install a speech recognition engine
-
-Talon uses a local speech recognition engine that translates voice audio to text. To install your speech engine, click the Talon tray icon and select `Speech Recognition → Conformer D`. For other engine options, see the [speech engine page](./Speech%20Engines/speech%20engines.md)
-
-## 3: Install a Talon user file set
-
-Talon does not come with voice commands out of the box. To start, we strongly recommend that you use the [Talon Community](https://github.com/talonhub/community) user file set. The whole wiki assumes this repository is used if not otherwise noted.
-
-See the [Talon Community README](https://github.com/talonhub/community?tab=readme-ov-file#installation) for installation instructions.
-
-In addition to [Talon Community](https://github.com/talonhub/community), you may want to consider installing any of the [essential Talon integrations](../Integrations/essential-tools.md)
-
-## 4: Test your Talon Setup
-
-- Try a few [basic commands](../Basic%20Usage/basic_usage.md).
-- If needed, try ways to [improve recognition accuracy](improving_recognition_accuracy.md)
-- [Customize Talon](../Customization/basic_customization.md): learn about how to configure Talon to your liking.
-- For earlier access to new features, priority support, and access to additional [speech engines](./Speech%20Engines/speech%20engines.md), install the [beta version](beta_talon.md).
-
-## Join the Talon Slack
-
-If at any point you need help with your Talon setup, join the [Talon Voice Slack](https://talonvoice.com/chat) and ask in the `#help` channel.
diff --git a/docs/Quickstart/Hardware/_category_.yml b/docs/Resource Hub/Hardware/_category_.yml
similarity index 100%
rename from docs/Quickstart/Hardware/_category_.yml
rename to docs/Resource Hub/Hardware/_category_.yml
diff --git a/docs/Quickstart/Hardware/hardware.md b/docs/Resource Hub/Hardware/hardware.md
similarity index 99%
rename from docs/Quickstart/Hardware/hardware.md
rename to docs/Resource Hub/Hardware/hardware.md
index 41ea8492..1e22b9dc 100644
--- a/docs/Quickstart/Hardware/hardware.md
+++ b/docs/Resource Hub/Hardware/hardware.md
@@ -57,7 +57,7 @@ Windows default drivers have a limitation and that they _cannot_ record and play
Check out the `#eye-tracking` channel in Slack, and the [Tobii 4c Tips](tobii_4c) page.
- Tobii 4C is a commonly used and recommended eye tracker, but it is slowly being superceded as the default as more folks are starting to use the Tobii 5. Talon also supports the Tobii PCEye Mini. Support for most 4th gen Tobii devices can be trivially added.
-- [Tobii 5](https://gaming.tobii.com/product/eye-tracker-5/) is the newer model and may be easier to find than the 4C. This one does require a one-time initialization on a Windows PC with the Tobii software installed. Check out the dedicated [Tobii 5 page](../Hardware/tobii_5.md).
+- [Tobii 5](https://gaming.tobii.com/product/eye-tracker-5/) is the newer model and may be easier to find than the 4C. This one does require a one-time initialization on a Windows PC with the Tobii software installed. Check out the dedicated [Tobii 5 page](tobii_5).
### Windows Login plus Talon
@@ -73,7 +73,7 @@ The customization for foot pedals is more involved than editing Talon files, and
- [Elgato Stream Deck Pedal](https://www.elgato.com/en/stream-deck-pedal) is natively supported in Talon beta and has 3 buttons.
- [Kinesis Savant Elite 2](https://kinesis-ergo.com/shop/savant-elite2-triple-pedal/) is mechanical and pedals can remap keys at the hardware level. It has 3 buttons.
-With the talon beta, the elegato foot pedal can be used as follows:
+With the Talon beta, the elegato foot pedal can be used as follows:
```talon
deck(pedal_left): print("left pedal")
diff --git a/docs/Resource Hub/Hardware/os.md b/docs/Resource Hub/Hardware/os.md
new file mode 100644
index 00000000..3a5874ce
--- /dev/null
+++ b/docs/Resource Hub/Hardware/os.md
@@ -0,0 +1,11 @@
+# Operating System
+
+:::info talon-scope-platform
+
+:::
+
+| System | Requirement |
+| ------------- | -------------------------------------------------------------------------------------------- |
+| `macOS` | High Sierra (10.13) or newer. Talon is a universal2 build with native Apple Silicon support. |
+| `Linux / X11` | (Ubuntu 18.04+, and most modern distros), Wayland support is currently limited to XWayland |
+| `Windows` | Windows 8 or newer |
diff --git a/docs/Quickstart/Hardware/tobii_4c.md b/docs/Resource Hub/Hardware/tobii_4c.md
similarity index 100%
rename from docs/Quickstart/Hardware/tobii_4c.md
rename to docs/Resource Hub/Hardware/tobii_4c.md
diff --git a/docs/Quickstart/Hardware/tobii_5.md b/docs/Resource Hub/Hardware/tobii_5.md
similarity index 93%
rename from docs/Quickstart/Hardware/tobii_5.md
rename to docs/Resource Hub/Hardware/tobii_5.md
index a4356d18..7ce1bbb9 100644
--- a/docs/Quickstart/Hardware/tobii_5.md
+++ b/docs/Resource Hub/Hardware/tobii_5.md
@@ -22,4 +22,4 @@ Regardless of which OS you will be using when you use your eye tracker, the init
### Next steps
-The [Tobii 4c tips](../Hardware/tobii_4c.md) page has detailed instructions on how to adjust your environment and behaviour to get a better eye tracking experience.
+The [Tobii 4c tips](../Hardware/tobii_4c) page has detailed instructions on how to adjust your environment and behaviour to get a better eye tracking experience.
diff --git a/docs/Quickstart/Speech Engines/Running-Linux-or-Mac-Talon-Using-Windows-Dragon.md b/docs/Resource Hub/Speech Recognition/Running-Linux-or-Mac-Talon-Using-Windows-Dragon.md
similarity index 100%
rename from docs/Quickstart/Speech Engines/Running-Linux-or-Mac-Talon-Using-Windows-Dragon.md
rename to docs/Resource Hub/Speech Recognition/Running-Linux-or-Mac-Talon-Using-Windows-Dragon.md
diff --git a/docs/Quickstart/improving_recognition_accuracy.md b/docs/Resource Hub/Speech Recognition/improving_recognition_accuracy.md
similarity index 97%
rename from docs/Quickstart/improving_recognition_accuracy.md
rename to docs/Resource Hub/Speech Recognition/improving_recognition_accuracy.md
index 2c22dddd..dba78ac3 100644
--- a/docs/Quickstart/improving_recognition_accuracy.md
+++ b/docs/Resource Hub/Speech Recognition/improving_recognition_accuracy.md
@@ -12,7 +12,7 @@ A quiet room will always be better than a noisy one. A good microphone can mitig
## Microphone
-Make sure that you have a good microphone and sound card, as speech recognition software requires better hardware than is commonly built in to computers. Have a look at the [hardware page](./Hardware/hardware.md) for recommendations and correct setup.
+Make sure that you have a good microphone and sound card, as speech recognition software requires better hardware than is commonly built in to computers. Have a look at the [hardware page](/docs/Resource%20Hub/Hardware/hardware.md) for recommendations and correct setup.
## Keep a relaxed voice
@@ -64,7 +64,7 @@ If recordings appear to be the correct length, Talon may be stuck due to a long-
## Help improving the Talon recognition engine
-This will not help you today, but instead help to improve the talon engine for all of us in the future. You can do this by providing speech (and noise) samples:
+This will not help you today, but instead help to improve the Talon engine for all of us in the future. You can do this by providing speech (and noise) samples:
- [Talon Speech Collection](https://speech.talonvoice.com/)
- [Talon Noise Collection](https://noise.talonvoice.com/)
diff --git a/docs/Quickstart/Speech Engines/speech engines.md b/docs/Resource Hub/Speech Recognition/speech engines.md
similarity index 97%
rename from docs/Quickstart/Speech Engines/speech engines.md
rename to docs/Resource Hub/Speech Recognition/speech engines.md
index 9eec6a40..07f45cc6 100644
--- a/docs/Quickstart/Speech Engines/speech engines.md
+++ b/docs/Resource Hub/Speech Recognition/speech engines.md
@@ -4,6 +4,10 @@ sidebar_position: 1
# Speech Engines
+:::info talon-scope-platform
+
+:::
+
Talon uses a speech recognition engine that translates voice audio to text. The Conformer speech engine is recommended, but it is possible to use Talon with other speech engines, for example, if you already use Dragon and want to use Talon with Dragon or need a speech engine with language support other than English.
| Engine | OS | Description | Installation | Price |
@@ -20,7 +24,7 @@ The Professional version of Dragon for Windows is recommended (but not strictly
### Dictation Engines for Additional Language Support
-As of April 2024, Talon's main conformer model only supports English. If you need to dictate text in another language, the [Talon Beta](../beta_talon) supports the following options:
+As of April 2024, Talon's main conformer model only supports English. If you need to dictate text in another language, the [Talon Beta](../../Help/beta_talon) supports the following options:
| Engine | Platform | Description | Requirements |
| --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
diff --git a/docs/Quickstart/troubleshooting.md b/docs/Resource Hub/Speech Recognition/troubleshooting.md
similarity index 85%
rename from docs/Quickstart/troubleshooting.md
rename to docs/Resource Hub/Speech Recognition/troubleshooting.md
index 3f798d8e..86deca49 100644
--- a/docs/Quickstart/troubleshooting.md
+++ b/docs/Resource Hub/Speech Recognition/troubleshooting.md
@@ -6,11 +6,11 @@ sidebar_position: 7
## Nothing Happens When I Speak
-If you are testing your setup with one of the [basic commands](../Basic%20Usage/basic_usage) and getting no response at all, first check a few fundamentals to help focus the troubleshooting. There are a number of issues at different layers of the setup that could be causing the problem. Your first few steps should help narrow the focus.
+If you are testing your setup with one of the [basic commands](../../Basic%20Usage/basic_usage) and getting no response at all, first check a few fundamentals to help focus the troubleshooting. There are a number of issues at different layers of the setup that could be causing the problem. Your first few steps should help narrow the focus.
### Check Your Microphone
-Your microphone is critical to your setup. If your microphone isn't working, then none of your voice commands will either. Testing this piece early may save you some time and help narrow down your troubleshooting to either hardware (microphone, audio interface, cables, etc) or software (talon, talon configuration, speech engine, etc).
+Your microphone is critical to your setup. If your microphone isn't working, then none of your voice commands will either. Testing this piece early may save you some time and help narrow down your troubleshooting to either hardware (microphone, audio interface, cables, etc) or software (Talon, Talon configuration, speech engine, etc).
Check that your computer is using the correct microphone and receiving sound input.
@@ -49,23 +49,23 @@ After you have started the Talon application, look for the Talon icon in the men
Talon's icon should show up in the menu bar in the upper right corner of your screen:
+
+### Advanced Users
+
+If you are an advanced user and have decided to install a different user file set, then not all parts
+of this wiki is relevant. Those that are will be highlighted as follows.
+
+
+
+ [SCOPE]: TALON PLATFORM
+
+
+
+---
+
## Goal of this Wiki
The goal of this wiki is to provide information and documentation for the users of Talon. As the software is under rapid development, this wiki is in a constant state of "work in progress". Some of this content exists temporarily until the official Talon Docs are created.
+---
+
## Wiki Navigation
-| If you are looking for: | See: |
-| ------------------------------------------------- | --------------------------------------------------------- |
-| Information on getting started with Talon | [Getting Started](/Quickstart/getting_started) |
-| How to customize Talon | [Basic Customization](/Customization/basic_customization) |
-| Troubleshooting help | [Troubleshooting](/Quickstart/troubleshooting) |
-| Help with deciding on a microphone or eye tracker | [Hardware](/Quickstart/Hardware) |
-| Videos of Talon in use | [Video Demos](/Integrations/talon_related_resources) |
-| Answers to frequently asked questions | [FAQ](/Quickstart/FAQ) |
+| If you are looking for: | See: |
+| ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| Videos of Talon in use | [Video Demos](/Integrations/talon_related_resources) |
+| Help with deciding on a microphone or eye tracker | [Hardware](/Resource%20Hub/Hardware) |
+| Installing and getting started with Talon | [Installing Talon](/Resource%20Hub/Talon%20Installation/installation_guide), [Basic Usage](/Basic%20Usage/basic_usage) |
+| How to customize Talon, obtaining additional functionality | [Basic Customization](/Customization/basic_customization), [Integrations](/Integrations/essential-tools) |
+| Troubleshooting help | [Troubleshooting](/Resource%20Hub/Speech%20Recognition/troubleshooting) |
+| Answers to frequently asked questions | [FAQ](/Help/FAQ) |
-## Talon Slack
+:::tip Talon Slack
-Talon has a Slack community for users to get help, ask questions, and meet one another. If you are starting to use Talon, join the [Talon Slack](https://talonvoice.com/chat). This is the most efficient way to get questions answered if they are not covered in this wiki. There are also a few general channels, like `#health`, for those looking for resources and other folks who might be navigating complex injuries like RSI (Repetitive Strain Injuries) from typing.
+Talon has a [Slack community](/Help/talon-slack) for users to get help, ask questions, and meet one another. This is the most efficient way to get questions answered if they are not covered in this wiki.
-A few notable channels:
+:::
-- `#help`: get help with Talon setup, usage, or ask questions about Talon
-- `#beta`: find beta download links and ask questions specific to the beta (this is a private channel that requires a patreon donation)
-- `#health`: chat with others about computer health issues, share knowledge, find other folks who might be going through similar things
-- `#talon-docs`: chat about Talon documentation such as this wiki
-- `#hardware`: chat about hardware, e.g., microphones
+---
# Contributing
diff --git a/src/theme/Admonition/Type/Info.tsx b/src/theme/Admonition/Type/Info.tsx
new file mode 100644
index 00000000..e11e9e4c
--- /dev/null
+++ b/src/theme/Admonition/Type/Info.tsx
@@ -0,0 +1,59 @@
+import React, { type ReactNode } from "react";
+import Info from "@theme-original/Admonition/Type/Info";
+import type InfoType from "@theme/Admonition/Type/Info";
+import type { WrapperProps } from "@docusaurus/types";
+
+type Props = WrapperProps;
+
+function ScopeIcon() {
+ return (
+
+ );
+}
+
+export default function InfoWrapper(props: Props): ReactNode {
+ const { title, children } = props;
+
+ let scope = null;
+ let body = null;
+ if (props.title == "talon-scope-platform") {
+ scope = "Talon Platform";
+ body = `This section is relevant to all users of the talon platform, regardless of whether or not the Talon community user file set
+ has also been installed.`;
+ } else if (props.title == "talon-scope-community") {
+ scope = "Talon Community User File Set";
+ body = (
+
+ This section is only relevant to users who have installed the
+
+ Talon community user file set
+
+
+ );
+ } else if (props.title == "talon-scope") {
+ scope = "";
+ body = children;
+ }
+ const isCustom = Boolean(body);
+ const heading = isCustom ? `[SCOPE] ${scope}` : null;
+
+ return (
+ <>
+ {isCustom ? (
+ } className="docoscope" title={heading}>
+ {body}
+
+ ) : (
+
+ )}
+ >
+ );
+}
diff --git a/static/img/talon-community-logo-social.png b/static/img/logos/talon-community-logo-social.png
similarity index 100%
rename from static/img/talon-community-logo-social.png
rename to static/img/logos/talon-community-logo-social.png
diff --git a/static/img/talon-community-logo.png b/static/img/logos/talon-community-logo.png
similarity index 100%
rename from static/img/talon-community-logo.png
rename to static/img/logos/talon-community-logo.png
diff --git a/static/img/talon.png b/static/img/logos/talon.png
similarity index 100%
rename from static/img/talon.png
rename to static/img/logos/talon.png
diff --git a/static/img/talon.svg b/static/img/logos/talon.svg
similarity index 100%
rename from static/img/talon.svg
rename to static/img/logos/talon.svg
diff --git a/static/img/talon_logo.png b/static/img/logos/talon_logo.png
similarity index 100%
rename from static/img/talon_logo.png
rename to static/img/logos/talon_logo.png