Fixed various document links, include custom platform/ community admonition

ronzulu · ronzulu · commit 06ac0e76f4f4 · 2025-03-07T22:36:26.000+11:00
diff --git a/docs/Basic Usage/settings.md b/docs/Basic Usage/settings.md
@@ -53,7 +53,7 @@ If the same setting is defined multiple times, Talon will use the setting value
 | 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/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
 
diff --git a/docs/Help/FAQ.md b/docs/Help/FAQ.md
@@ -14,15 +14,15 @@ Talon does not require special configuration for different programming languages
 
 ### What hardware should I have?
 
-Check out the [hardware](../Resource%20Hub/Hardware/hardware) page for microphone and eye tracker recommendations.
+Check out the [hardware](/docs/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?
 
-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?
 
@@ -35,4 +35,4 @@ While Talon is closed source, there's plenty you can do to help:
 
 ### Troubleshooting
 
-Checkout the [troubleshooting](troubleshooting) for solutions to common problems.
+Checkout the [troubleshooting](../Resource%20Hub/Speech%20Recognition/troubleshooting) for solutions to common problems.
diff --git a/docs/Integrations/accessibility.md b/docs/Integrations/accessibility.md
@@ -8,9 +8,8 @@ Please note that Talon is in rapid development and is largely community supporte
 
 ### How to get started
 
-- Setup Talon according to the standard [quickstart](../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
diff --git a/docs/Resource Hub/Hardware/os.md 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/Resource Hub/Speech Recognition/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) 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
 
diff --git a/docs/Resource Hub/Speech Recognition/speech engines.md b/docs/Resource Hub/Speech Recognition/speech engines.md
@@ -4,6 +4,10 @@ sidebar_position: 1
 
 # Speech Engines
 
+:::docoscope 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/Resource Hub/Speech Recognition/troubleshooting.md b/docs/Resource Hub/Speech Recognition/troubleshooting.md
@@ -6,7 +6,7 @@ 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
 
@@ -55,7 +55,7 @@ Talon's icon should show up in the menu bar in the upper right corner of your sc
 
 ### Check that Talon is Awake
 
-When Talon is running, it will be in one of a few different [modes](../Basic%20Usage/basic_usage). One of these modes is a `sleep` mode, which will put Talon in a dormant state where it is listening but not responding to commands. While asleep, Talon will only respond to a minimal set of commands, such as `talon wake`, which will put Talon out of sleep and enable Talon to respond to commands.
+When Talon is running, it will be in one of a few different [modes](../../Basic%20Usage/basic_usage). One of these modes is a `sleep` mode, which will put Talon in a dormant state where it is listening but not responding to commands. While asleep, Talon will only respond to a minimal set of commands, such as `talon wake`, which will put Talon out of sleep and enable Talon to respond to commands.
 
 If you are trying to use Talon commands and Talon is not responding, make sure Talon is not in sleep mode. The Talon icon in the menubar provides some visual cue as to what mode Talon is in:
 
@@ -133,7 +133,7 @@ Check that your speech engine has been initialized by looking in the [talon log
 
 ### Check your Talon user file sets
 
-Check you have some valid commands in `~/.talon/user`. If it's empty, install the [Talon Community](https://github.com/talonhub/community) user file set and test with some [basic commands](../Basic%20Usage/basic_usage). Install the entire repository, not just individual files. This user file set can be combined with other Talon user file sets, though it is common that most of the functionality will be provided by [Talon Community](https://github.com/talonhub/community). Additional file sets are commonly used to customize the default behavior provided by [Talon Community](https://github.com/talonhub/community) or add additional features not already included.
+Check you have some valid commands in `~/.talon/user`. If it's empty, install the [Talon Community](https://github.com/talonhub/community) user file set and test with some [basic commands](../../Basic%20Usage/basic_usage). Install the entire repository, not just individual files. This user file set can be combined with other Talon user file sets, though it is common that most of the functionality will be provided by [Talon Community](https://github.com/talonhub/community). Additional file sets are commonly used to customize the default behavior provided by [Talon Community](https://github.com/talonhub/community) or add additional features not already included.
 
 Talon automatically tracks changes to files in `~/.talon/user`, so that one can change scripts on the fly. This breaks if `~/.talon` (or any other part of the path) is a symlink.
 
diff --git a/docs/Resource Hub/Talon Installation/installation_guide.md b/docs/Resource Hub/Talon Installation/installation_guide.md
@@ -4,16 +4,17 @@ sidebar_position: 1.1
 
 # Installation Guide
 
-:::docoscope Talon Platform
+:::info talon-scope-platform
 
 Although much of this page is pertinent to the talon platform itself,
 some steps are specific to the talon community user file set, and will be marked as such.
 
 :::
 
+
 ## 1: Check System Requirements
 
-Talon has various [system requirements](../Hardware/hardware.md), covering the computer hardware, operating system and microphone hardware.
+Talon has various [system requirements](../Hardware/os), covering the computer hardware, operating system and microphone hardware.
 
 ## 2: Download & Install Talon
 
@@ -92,12 +93,12 @@ the talon user directory.
 the [talon user directory](/docs/Resource%20Hub/terminology).
 -->
 
-:::docoscope community
+:::info talon-scope-community
 
 :::
 
 This can be done one of two ways - either as a `zip` file or by using `git`.
-Considerations in choosing between the two methods, as well as instructions, are described [here](../Resource%20Hub/Talon%20Installation/downloading-community).
+Considerations in choosing between the two methods, as well as instructions, are described [here](../Talon%20Installation/downloading-community).
 
 ## 5: Test your Talon Setup
 
diff --git a/src/css/custom.css b/src/css/custom.css
@@ -41,24 +41,20 @@
  color: var(--shiki-dark) !important;
 }
 
-.alert--docotodo {
-  --ifm-alert-background-color: rgb(121, 68, 146);
-  --ifm-alert-background-color-highlight: rgb(121, 68, 146);
-  --ifm-alert-foreground-color: white;
-  --ifm-alert-border-color: rgb(58, 23, 73);
+.theme-admonition.docotodo {
+    background-color: rgb(121, 68, 146);
+    border-left: 4px solid rgb(58, 23, 73);
+    color: white;
 }
 
-.alert--docofeedback {
-  --ifm-alert-background-color: rgb(92, 104, 61);
-  --ifm-alert-background-color-highlight: rgb(92, 104, 61);
-  --ifm-alert-foreground-color: white;
-  --ifm-alert-border-color: rgb(4, 43, 7);
+.theme-admonition.docofeedback {
+    background-color: rgb(92, 104, 61);
+    border-left: 4px solid rgb(4, 43, 7);
+    color: white;
 }
 
-.alert--docoscope {
-  --ifm-alert-background-color: #373255;
-  --ifm-alert-background-color-highlight: #373255;
-  --ifm-alert-foreground-color: white;
-  --ifm-alert-border-color: #651FFF;
+.theme-admonition.docoscope {
+    background-color: #373255;
+    border-left: 4px solid #651FFF;
+    color: white;
 }
-  
diff --git a/src/theme/Admonition/Type/Info.tsx b/src/theme/Admonition/Type/Info.tsx
@@ -0,0 +1,49 @@
+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<typeof InfoType>;
+
+function ScopeIcon() {
+    return (
+        <svg viewBox="0 0 24 24">
+            <path d="M4 12H4.01M8 12H8.01M16 12H16.01M12 12H12.01M20 12H20.01M8.5 4H7.2C6.0799 4 5.51984 4 5.09202 4.21799C4.71569 4.40973 4.40973 4.71569 4.21799 5.09202C4 5.51984 4 6.0799 4 7.2V8.5M15.5 4H16.8C17.9201 4 18.4802 4 18.908 4.21799C19.2843 4.40973 19.5903 4.71569 19.782 5.09202C20 5.51984 20 6.07989 20 7.2V8.5M20 15.5V16.8C20 17.9201 20 18.4802 19.782 18.908C19.5903 19.2843 19.2843 19.5903 18.908 19.782C18.4802 20 17.9201 20 16.8 20H15.5M4 15.5V16.8C4 17.9201 4 18.4802 4.21799 18.908C4.40973 19.2843 4.71569 19.5903 5.09202 19.782C5.51984 20 6.0799 20 7.2 20H8.5" 
+            stroke="#ffffff" stroke-width="1" stroke-linecap="round" stroke-linejoin="round"/>
+        </svg>
+    );
+}
+
+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 = (<span>This section is only relevant to users who have installed the 
+            <a href="Resource Hub/Talon Installation/downloading-community">Talon community user file set</a></span>);
+    } else if (props.title == "talon-scope") {
+        scope = "";
+        body = children;
+    }
+    const isCustom = Boolean(body);
+    const heading = isCustom ? `[SCOPE] ${scope}` : null;
+
+    
+    return (
+        <>
+        {  isCustom ?
+            <Info icon={<ScopeIcon />} className="docoscope" title={heading} >
+                {body} 
+            </Info>
+            :
+            <Info {...props} />
+        }
+        </>
+    );
+}
