Use actual links to vscode settings in docs (#3192)

Author: AndreasArvidsson

README.md

@@ -41,14 +41,14 @@ See [installation](https://www.cursorless.org/docs/user/installation/) for insta
 
 This extension contributes the following settings:
 
-- `cursorless.showOnStart`: Whether decorations should appear on workspace start
-- `cursorless.hatSizeAdjustment`: Percentage to increase or decrease hat size; positive increases size
-- `cursorless.hatVerticalOffset`: How much to vertically shift the hats as a percentage of font size; positive is up
-- `cursorless.hatEnablement.colors`: Whether to enable particular hat colors.
-- `cursorless.hatEnablement.shapes`: Whether to enable particular hat shapes.
-- `cursorless.hatPenalties.colors`: How much to penalize each hat color. You will probably want to set this one to the number of syllables in the given style. Cursorless will then sort every style combination by number of syllables to refer to it.
-- `cursorless.hatPenalties.shapes`: How much to penalize each hat shape. You will probably want to set this one to the number of syllables in the given style. Cursorless will then sort every style combination by number of syllables to refer to it.
-- `cursorless.maximumHatStylePenalty`: The maximum allowed penalty for a hat style. Any hat style whose penalty is greater than this amount will not be used. A hat style penalty is defined to be the shape penalty plus the colour penalty. Setting this value less than or equal to zero is treated as no maximum.
+- [`cursorless.showOnStart`](vscode://settings/cursorless.showOnStart): Whether decorations should appear on workspace start
+- [`cursorless.hatSizeAdjustment`](vscode://settings/cursorless.hatSizeAdjustment): Percentage to increase or decrease hat size; positive increases size
+- [`cursorless.hatVerticalOffset`](vscode://settings/cursorless.hatVerticalOffset): How much to vertically shift the hats as a percentage of font size; positive is up
+- [`cursorless.hatEnablement.colors`](vscode://settings/cursorless.hatEnablement.colors): Whether to enable particular hat colors.
+- [`cursorless.hatEnablement.shapes`](vscode://settings/cursorless.hatEnablement.shapes): Whether to enable particular hat shapes.
+- [`cursorless.hatPenalties.colors`](vscode://settings/cursorless.hatPenalties.colors): How much to penalize each hat color. You will probably want to set this one to the number of syllables in the given style. Cursorless will then sort every style combination by number of syllables to refer to it.
+- [`cursorless.hatPenalties.shapes`](vscode://settings/cursorless.hatPenalties.shapes): How much to penalize each hat shape. You will probably want to set this one to the number of syllables in the given style. Cursorless will then sort every style combination by number of syllables to refer to it.
+- [`cursorless.maximumHatStylePenalty`](vscode://settings/cursorless.maximumHatStylePenalty): The maximum allowed penalty for a hat style. Any hat style whose penalty is greater than this amount will not be used. A hat style penalty is defined to be the shape penalty plus the colour penalty. Setting this value less than or equal to zero is treated as no maximum.
 
 ## Known Issues
 

packages/cursorless-org-docs/src/docs/user/README.md

@@ -64,14 +64,14 @@ The following colors are supported. Note that to target the default (gray) hat y
 | `"navy"`    | navy    | `userColor1` | ❌                  |
 | `"apricot"` | apricot | `userColor2` | ❌                  |
 
-You can enable or disable colors in your VSCode settings, by searching for `cursorless.hatEnablement.colors` and checking the box next to the internal ID for the given shape as listed above. To navigate to your VSCode settings, either say "show settings", or go to File --> Preferences --> Settings.
+You can enable or disable colors in your VSCode settings, by searching for [`cursorless.hatEnablement.colors`](vscode://settings/cursorless.hatEnablement.colors) and checking the box next to the internal ID for the given shape as listed above. To navigate to your VSCode settings, either say "show settings", or go to File --> Preferences --> Settings.
 
-You can also tweak the visible colors for any of these colors in your VSCode settings, by searching for `cursorless.colors` and changing the hex color code next to the internal ID for the given shape as listed above. Note that you can configure different colors for dark and light themes. See our [visual accessibility guide](visualAccessibility.md) for more on visual accessibility.
+You can also tweak the visible colors for any of these colors in your VSCode settings, by searching for [`cursorless.colors`](vscode://settings/cursorless.colors) and changing the hex color code next to the internal ID for the given shape as listed above. Note that you can configure different colors for dark and light themes. See our [visual accessibility guide](visualAccessibility.md) for more on visual accessibility.
 
 If you find these color names unintuitive / tough to remember, their
 spoken forms can be [customized](customization.md) like any other spoken form
 in Cursorless. If you change a spoken form to be more than one syllable, you
-can change the penalty in the `cursorless.hatPenalties.colors` setting to the
+can change the penalty in the [`cursorless.hatPenalties.colors`](vscode://settings/cursorless.hatPenalties.colors) setting to the
 number of syllables you use, so that Cursorless can optimize hat allocation to
 minimize syllables.
 
@@ -93,12 +93,12 @@ The following shapes are supported. Note that to target the default (dot) shape
 | `"cross"`   | ![Crosshairs](../../../../../images/hats/crosshairs.svg) | `crosshairs` | ❌                  |
 | `"eye"`     | ![Eye](../../../../../images/hats/eye.svg)               | `eye`        | ❌                  |
 
-You can enable or disable shapes in your VSCode settings, by searching for `cursorless.hatEnablement.shapes` and checking the box next to the internal ID for the given shape as listed above. To navigate to your VSCode settings, either say "show settings", or go to File --> Preferences --> Settings.
+You can enable or disable shapes in your VSCode settings, by searching for [`cursorless.hatEnablement.shapes`](vscode://settings/cursorless.hatEnablement.shapes) and checking the box next to the internal ID for the given shape as listed above. To navigate to your VSCode settings, either say "show settings", or go to File --> Preferences --> Settings.
 
 If you find these shape names unintuitive / tough to remember, their
 spoken forms can be [customized](customization.md) like any other spoken form
 in cursorless. If you change a spoken form to be more than one syllable, you
-can change the penalty in the `cursorless.hatPenalties.shapes` setting to the
+can change the penalty in the [`cursorless.hatPenalties.shapes`](vscode://settings/cursorless.hatPenalties.shapes) setting to the
 number of syllables you use, so that cursorless can optimize hat allocation to
 minimize syllables.
 

packages/cursorless-org-docs/src/docs/user/customization.md

@@ -128,7 +128,7 @@ hats off: user.run_rpc_command("cursorless.toggleDecorations", false)
 
 ## Updating word separators
 
-The word separators are characters that defines the boundary between words in a identifier. eg `hello_world` is an identifier with two words separated by `_`. If you like to support other separators like `-` in `hello-world` that can be accomplished by changing the `cursorless.wordSeparators` setting. This setting is also language overridable.
+The word separators are characters that defines the boundary between words in a identifier. eg `hello_world` is an identifier with two words separated by `_`. If you like to support other separators like `-` in `hello-world` that can be accomplished by changing the [`cursorless.wordSeparators`](vscode://settings/cursorless.wordSeparators) setting. This setting is also language overridable.
 
 ```json
 // Sets the word separator for all languages

packages/cursorless-org-docs/src/docs/user/hatAssignment.md

@@ -25,7 +25,7 @@ When a token is picking its hat, it will have a pool of available hats based on
 
 One of these candidate hats might be the hat the token was already wearing before this pass started (if it had one), and some of them will be hats that lower ranked tokens were wearing before the pass started.
 
-The token will start by figuring out the penalty of the best candidate hat (eg is there a gray dot? Are they all colored shapes? etc). Based on that penalty, it will consider only the candidate hats whose penalty is sufficiently close to the best hat. The definition of "sufficiently close" is determined by the user setting `cursorless.experimental.hatStability`:
+The token will start by figuring out the penalty of the best candidate hat (eg is there a gray dot? Are they all colored shapes? etc). Based on that penalty, it will consider only the candidate hats whose penalty is sufficiently close to the best hat. The definition of "sufficiently close" is determined by the user setting [`cursorless.experimental.hatStability`](vscode://settings/cursorless.experimental.hatStability):
 
 | Setting value          | Behaviour                                                                                                                                                                                                                                                           |
 | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

packages/cursorless-org-docs/src/docs/user/localCommandHIstory.md

@@ -4,7 +4,7 @@ By default, Cursorless doesn't capture anything about your usage. However, we do
 
 The idea is that these statistics can be used in the future for doing local analyses to determine ways you can improve your Cursorless efficiency. We may also support a way for you to send your statistics to us for analysis in the future, but this will be opt-in only.
 
-To enable local, sanitized command logging, enable the `cursorless.commandHistory` VSCode setting. You should see a checkbox in the settings UI when you say `"cursorless settings"`. You can also set it manually in your `settings.json`:
+To enable local, sanitized command logging, enable the [`cursorless.commandHistory`](vscode://settings/cursorless.commandHistory) VSCode setting. You should see a checkbox in the settings UI when you say `"cursorless settings"`. You can also set it manually in your `settings.json`:
 
 ```json
   "cursorless.commandHistory": true

packages/cursorless-org-docs/src/docs/user/visualAccessibility.md

@@ -4,25 +4,25 @@ Cursorless has multiple settings that can be customized to improve accessibility
 
 ## Make the hats bigger
 
-Say `"cursorless settings"` and find the `cursorless.hatSize` setting. This setting allows you to increase the size of the hats. You may need to change the vertical offset of the hats to keep them from clipping the line below / above.
+Say `"cursorless settings"` and find the [`cursorless.hatSizeAdjustment`](vscode://settings/cursorless.hatSizeAdjustment) setting. This setting allows you to increase the size of the hats. You may need to change the vertical offset of the hats to keep them from clipping the line below / above.
 
 You may also want to increase your line height to allow you to make the hats even larger: say `"show settings say line height"` and increase the line height to your preference.
 
 A reasonable place to start is to set the line height to 1.6 and the hat size to 70.
 
 ## Use shapes instead of colors
 
-If you are a user with color blindness, it may be helpful to disable a subset or all colors and enable shapes instead. You can do so by saying `"cursorless settings"` and finding the `cursorless.hatEnablement.colors` and `cursorless.hatEnablement.shapes` settings.
+If you are a user with color blindness, it may be helpful to disable a subset or all colors and enable shapes instead. You can do so by saying `"cursorless settings"` and finding the [`cursorless.hatEnablement.colors`](vscode://settings/cursorless.hatEnablement.colors) and [`cursorless.hatEnablement.shapes`](vscode://settings/cursorless.hatEnablement.shapes) settings.
 
 ## Tweak your color scheme
 
-You can change the colors of the hats by saying `"cursorless settings"` and finding the `cursorless.colors.light` and `cursorless.colors.dark` settings.
+You can change the colors of the hats by saying `"cursorless settings"` and finding the [`cursorless.colors.light`](vscode://settings/cursorless.colors.light) and [`cursorless.colors.dark`](vscode://settings/cursorless.colors.dark) settings.
 
 There are several user-created color schemes available [on the Cursorless wiki](https://github.com/cursorless-dev/cursorless/wiki/Color-schemes). One notable color scheme is the [Greyscale for Night Owl theme](https://github.com/cursorless-dev/cursorless/wiki/Color-schemes#greyscale-for-night-owl-theme), which is designed to reduce visual stimulation and be compatible with most forms of color blindness. Instead of colors like "yellow", "green", etc, it uses "bright" and "dark". Here's how you use it:
 
-1. Say `"cursorless settings"` and find the `cursorless.colors.light` or `cursorless.colors.dark` settings depending on your preferred mode
+1. Say `"cursorless settings"` and find the [`cursorless.colors.light`](vscode://settings/cursorless.colors.light) or [`cursorless.colors.dark`](vscode://settings/cursorless.colors.dark) settings depending on your preferred mode
 1. Change your `default` color to `#848384`
 1. Change your `blue` color to `#ffffff`
 1. Change your `green` color to `#333333`
-1. Disable the other colors using the `cursorless.hatEnablement.colors` setting
+1. Disable the other colors using the [`cursorless.hatEnablement.colors`](vscode://settings/cursorless.hatEnablement.colors) setting
 1. Change spoken forms within your Cursorless settings folder located at `cursorless-settings/hat_styles.csv` so that you have `bright, blue` and `dark, green`. This is within your Talon configuration, not the IDE settings. This will change the spoken forms to match the new colors so that you can say eg `"take bright air"` to select the word "air" with a bright hat. See [Customization](./customization.md) for more information on how to change spoken forms.