More link conversions.

tzarc · May 25, 2024 · a0adc58 · a0adc58
1 parent 81d308f
commit a0adc58
Show file tree

Hide file tree

Showing 16 changed files with 31 additions and 31 deletions.
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
@@ -793,15 +793,15 @@ Run single test:
 
 ## `qmk painter-convert-graphics`
 
-This command converts images to a format usable by QMK, i.e. the QGF File Format. See the [Quantum Painter](quantum_painter.md?id=quantum-painter-cli) documentation for more information on this command.
+This command converts images to a format usable by QMK, i.e. the QGF File Format. See the [Quantum Painter](quantum_painter.md#quantum-painter-cli) documentation for more information on this command.
 
 ## `qmk painter-make-font-image`
 
-This command converts a TTF font to an intermediate format for editing, before converting to the QFF File Format. See the [Quantum Painter](quantum_painter.md?id=quantum-painter-cli) documentation for more information on this command.
+This command converts a TTF font to an intermediate format for editing, before converting to the QFF File Format. See the [Quantum Painter](quantum_painter.md#quantum-painter-cli) documentation for more information on this command.
 
 ## `qmk painter-convert-font-image`
 
-This command converts an intermediate font image to the QFF File Format. See the [Quantum Painter](quantum_painter.md?id=quantum-painter-cli) documentation for more information on this command.
+This command converts an intermediate font image to the QFF File Format. See the [Quantum Painter](quantum_painter.md#quantum-painter-cli) documentation for more information on this command.
 
 ## `qmk test-c`
 

diff --git a/docs/config_options.md b/docs/config_options.md
@@ -56,10 +56,10 @@ This is a C header file that is one of the first things included, and will persi
  * the number of columns in your keyboard's matrix
 * `#define MATRIX_ROW_PINS { D0, D5, B5, B6 }`
  * pins of the rows, from top to bottom
- * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md?id=low-level-matrix-overrides) for more information.
+ * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md#low-level-matrix-overrides) for more information.
 * `#define MATRIX_COL_PINS { F1, F0, B0, C7, F4, F5, F6, F7, D4, D6, B4, D7 }`
  * pins of the columns, from left to right
- * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md?id=low-level-matrix-overrides) for more information.
+ * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md#low-level-matrix-overrides) for more information.
 * `#define MATRIX_IO_DELAY 30`
  * the delay in microseconds when between changing matrix pin state and reading values
 * `#define MATRIX_HAS_GHOST`
@@ -215,14 +215,14 @@ If you define these options you will enable the associated feature, which may in
 * `#define WS2812_DI_PIN D7`
  * pin the DI on the WS2812 is hooked-up to
 * `#define RGBLIGHT_LAYERS`
- * Lets you define [lighting layers](feature_rgblight.md?id=lighting-layers) that can be toggled on or off. Great for showing the current keyboard layer or caps lock state.
+ * Lets you define [lighting layers](feature_rgblight.md#lighting-layers) that can be toggled on or off. Great for showing the current keyboard layer or caps lock state.
 * `#define RGBLIGHT_MAX_LAYERS`
- * Defaults to 8. Can be expanded up to 32 if more [lighting layers](feature_rgblight.md?id=lighting-layers) are needed.
+ * Defaults to 8. Can be expanded up to 32 if more [lighting layers](feature_rgblight.md#lighting-layers) are needed.
  * Note: Increasing the maximum will increase the firmware size and slow sync on split keyboards.
 * `#define RGBLIGHT_LAYER_BLINK`
- * Adds ability to [blink](feature_rgblight.md?id=lighting-layer-blink) a lighting layer for a specified number of milliseconds (e.g. to acknowledge an action).
+ * Adds ability to [blink](feature_rgblight.md#lighting-layer-blink) a lighting layer for a specified number of milliseconds (e.g. to acknowledge an action).
 * `#define RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF`
- * If defined, then [lighting layers](feature_rgblight?id=overriding-rgb-lighting-onoff-status) will be shown even if RGB Light is off.
+ * If defined, then [lighting layers](feature_rgblight.md#overriding-rgb-lighting-onoff-status) will be shown even if RGB Light is off.
 * `#define RGBLIGHT_LED_COUNT 12`
  * number of LEDs
 * `#define RGBLIGHT_SPLIT`
@@ -294,7 +294,7 @@ There are a few different ways to set handedness for split keyboards (listed in
 * `#define MATRIX_ROW_PINS_RIGHT { <row pins> }`
 * `#define MATRIX_COL_PINS_RIGHT { <col pins> }`
  * If you want to specify a different pinout for the right half than the left half, you can define `MATRIX_ROW_PINS_RIGHT`/`MATRIX_COL_PINS_RIGHT`. Currently, the size of `MATRIX_ROW_PINS` must be the same as `MATRIX_ROW_PINS_RIGHT` and likewise for the definition of columns.
- * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md?id=low-level-matrix-overrides) for more information.
+ * may be omitted by the keyboard designer if matrix reads are handled in an alternate manner. See [low-level matrix overrides](custom_quantum_functions.md#low-level-matrix-overrides) for more information.
 
 * `#define DIRECT_PINS_RIGHT { { F1, F0, B0, C7 }, { F4, F5, F6, F7 } }`
  * If you want to specify a different direct pinout for the right half than the left half, you can define `DIRECT_PINS_RIGHT`. Currently, the size of `DIRECT_PINS` must be the same as `DIRECT_PINS_RIGHT`.

diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md
@@ -204,7 +204,7 @@ Similar to `matrix_scan_*`, these are called as often as the MCU can handle. To
 
 ### Example `void housekeeping_task_user(void)` implementation
 
-This example will show you how to use `void housekeeping_task_user(void)` to turn off [RGB Light](feature_rgblight.md). For RGB Matrix, the [builtin](feature_rgb_matrix?id=additional-configh-options) `RGB_MATRIX_TIMEOUT` should be used.
+This example will show you how to use `void housekeeping_task_user(void)` to turn off [RGB Light](feature_rgblight.md). For RGB Matrix, the [builtin](feature_rgb_matrix.md#additional-configh-options) `RGB_MATRIX_TIMEOUT` should be used.
 
 First, add the following lines to your keymap's `config.h`:
 

diff --git a/docs/feature_advanced_keycodes.md b/docs/feature_advanced_keycodes.md
@@ -160,7 +160,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  return true;
 };
 ```
-Alternatively, this can be done with [Key Overrides](feature_key_overrides?id=simple-example).
+Alternatively, this can be done with [Key Overrides](feature_key_overrides.md#simple-example).
 
 # Advanced topics {#advanced-topics}
 

diff --git a/docs/feature_pointing_device.md b/docs/feature_pointing_device.md
@@ -412,7 +412,7 @@ The `POINTING_DEVICE_CS_PIN`, `POINTING_DEVICE_SDIO_PIN`, and `POINTING_DEVICE_S
 
 ## Split Keyboard Configuration
 
-The following configuration options are only available when using `SPLIT_POINTING_ENABLE` see [data sync options](feature_split_keyboard.md?id=data-sync-options). The rotation and invert `*_RIGHT` options are only used with `POINTING_DEVICE_COMBINED`. If using `POINTING_DEVICE_LEFT` or `POINTING_DEVICE_RIGHT` use the common configuration above to configure your pointing device.
+The following configuration options are only available when using `SPLIT_POINTING_ENABLE` see [data sync options](feature_split_keyboard.md#data-sync-options). The rotation and invert `*_RIGHT` options are only used with `POINTING_DEVICE_COMBINED`. If using `POINTING_DEVICE_LEFT` or `POINTING_DEVICE_RIGHT` use the common configuration above to configure your pointing device.
 
 | Setting | Description | Default |
 | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | ------------- |
@@ -425,7 +425,7 @@ The following configuration options are only available when using `SPLIT_POINTIN
 | `POINTING_DEVICE_INVERT_X_RIGHT` | (Optional) Inverts the X axis report. | _not defined_ |
 | `POINTING_DEVICE_INVERT_Y_RIGHT` | (Optional) Inverts the Y axis report. | _not defined_ |
 
-!> If there is a `_RIGHT` configuration option or callback, the [common configuration](feature_pointing_device.md?id=common-configuration) option will work for the left. For correct left/right detection you should setup a [handedness option](feature_split_keyboard?id=setting-handedness), `EE_HANDS` is usually a good option for an existing board that doesn't do handedness by hardware.
+!> If there is a `_RIGHT` configuration option or callback, the [common configuration](feature_pointing_device.md#common-configuration) option will work for the left. For correct left/right detection you should setup a [handedness option](feature_split_keyboard.md#setting-handedness), `EE_HANDS` is usually a good option for an existing board that doesn't do handedness by hardware.
 
 
 ## Callbacks and Functions 
@@ -448,7 +448,7 @@ The following configuration options are only available when using `SPLIT_POINTIN
 
 ## Split Keyboard Callbacks and Functions
 
-The combined functions below are only available when using `SPLIT_POINTING_ENABLE` and `POINTING_DEVICE_COMBINED`. The 2 callbacks `pointing_device_task_combined_*` replace the single sided equivalents above. See the [combined pointing devices example](feature_pointing_device.md?id=combined-pointing-devices)
+The combined functions below are only available when using `SPLIT_POINTING_ENABLE` and `POINTING_DEVICE_COMBINED`. The 2 callbacks `pointing_device_task_combined_*` replace the single sided equivalents above. See the [combined pointing devices example](feature_pointing_device.md#combined-pointing-devices)
 
 | Function | Description |
 | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |

diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
@@ -1035,7 +1035,7 @@ bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
 }
 ```
 
-?> Split keyboards will require layer state data syncing with `#define SPLIT_LAYER_STATE_ENABLE`. See [Data Sync Options](feature_split_keyboard?id=data-sync-options) for more details.
+?> Split keyboards will require layer state data syncing with `#define SPLIT_LAYER_STATE_ENABLE`. See [Data Sync Options](feature_split_keyboard.md#data-sync-options) for more details.
 
 #### Examples {#indicator-examples}
 

diff --git a/docs/feature_split_keyboard.md b/docs/feature_split_keyboard.md
@@ -292,7 +292,7 @@ This enables transmitting the current ST7565 on/off status to the slave side of
 
 This enables transmitting the pointing device status to the master side of the split keyboard. The purpose of this feature is to enable use pointing devices on the slave side. 
 
-!> There is additional required configuration for `SPLIT_POINTING_ENABLE` outlined in the [pointing device documentation](feature_pointing_device.md?id=split-keyboard-configuration).
+!> There is additional required configuration for `SPLIT_POINTING_ENABLE` outlined in the [pointing device documentation](feature_pointing_device.md#split-keyboard-configuration).
 
 ```c
 #define SPLIT_HAPTIC_ENABLE

diff --git a/docs/feature_swap_hands.md b/docs/feature_swap_hands.md
@@ -30,7 +30,7 @@ Note that the array indices are reversed same as the matrix and the values are o
 |`QK_SWAP_HANDS_TAP_TOGGLE` |`SH_TT` |Momentary swap when held, toggle when tapped |
 |`QK_SWAP_HANDS_ONE_SHOT` |`SH_OS` |Turn on hand swap while held or until next key press|
 
-`SH_TT` swap-hands tap-toggle key is similar to [layer tap-toggle](feature_layers.md?id=switching-and-toggling-layers). Tapping repeatedly (5 taps by default) will toggle swap-hands on or off, like `SH_TOGG`. Tap-toggle count can be changed by defining a value for `TAPPING_TOGGLE`.
+`SH_TT` swap-hands tap-toggle key is similar to [layer tap-toggle](feature_layers.md#switching-and-toggling-layers). Tapping repeatedly (5 taps by default) will toggle swap-hands on or off, like `SH_TOGG`. Tap-toggle count can be changed by defining a value for `TAPPING_TOGGLE`.
 
 ## Encoder Mapping
 

diff --git a/docs/newbs_building_firmware_configurator.md b/docs/newbs_building_firmware_configurator.md
@@ -4,7 +4,7 @@
 
 The [QMK Configurator](https://config.qmk.fm) is an online graphical user interface that generates QMK Firmware `.hex` or `.bin` files.
 
-It should be noted that Configurator cannot produce firmwares for keyboards using a different controller than they were designed for, i.e. an RP2040 controller on a board designed for pro micro. You will have to use the command line [converters](feature_converters?id=supported-converters) for this.
+It should be noted that Configurator cannot produce firmwares for keyboards using a different controller than they were designed for, i.e. an RP2040 controller on a board designed for pro micro. You will have to use the command line [converters](feature_converters.md#supported-converters) for this.
 
 Watch the [Video Tutorial](https://www.youtube.com/watch?v=-imgglzDMdY). Many people find that is enough information to start programming their own keyboard.
 

diff --git a/docs/newbs_building_firmware_workflow.md b/docs/newbs_building_firmware_workflow.md
@@ -173,7 +173,7 @@ Files committed to GitHub in the previous step will automatically trigger the wo
 4. Successfully compiled firmware will be under the "**Artifacts**" section.
 5. If there are build errors, review the job log for details.
 
-Download and flash the firmware file into your keyboard using [QMK Toolbox](newbs_flashing?id=flashing-your-keyboard-with-qmk-toolbox).
+Download and flash the firmware file into your keyboard using [QMK Toolbox](newbs_flashing.md#flashing-your-keyboard-with-qmk-toolbox).
 
 
 ## Customising your keymap

diff --git a/docs/newbs_flashing.md b/docs/newbs_flashing.md
@@ -31,7 +31,7 @@ The simplest way to flash your keyboard will be with the [QMK Toolbox](https://g
 
 However, the Toolbox is currently only available for Windows and macOS. If you're using Linux (or just wish to flash the firmware from the command line), skip to the [Flash your Keyboard from the Command Line](#flash-your-keyboard-from-the-command-line) section.
 
-?> QMK Toolbox is not necessary for flashing [RP2040 devices](flashing?id=raspberry-pi-rp2040-uf2).
+?> QMK Toolbox is not necessary for flashing [RP2040 devices](flashing.md#raspberry-pi-rp2040-uf2).
 
 ### Load the File into QMK Toolbox
 

diff --git a/docs/newbs_getting_started.md b/docs/newbs_getting_started.md
@@ -154,7 +154,7 @@ In most situations you will want to answer `y` to all of the prompts.
 
 <!-- tabs:end -->
 
-?> The qmk home folder can be specified at setup with `qmk setup -H <path>`, and modified afterwards using the [cli configuration](cli_configuration.md?id=single-key-example) and the variable `user.qmk_home`. For all available options run `qmk setup --help`.
+?> The qmk home folder can be specified at setup with `qmk setup -H <path>`, and modified afterwards using the [cli configuration](cli_configuration.md#single-key-example) and the variable `user.qmk_home`. For all available options run `qmk setup --help`.
 
 ?> If you already know how to use GitHub, [we recommend that you follow these instructions](getting_started_github.md) and use `qmk setup <github_username>/qmk_firmware` to clone your personal fork. If you don't know what that means you can safely ignore this message.
 

diff --git a/docs/porting_your_keyboard_to_qmk.md b/docs/porting_your_keyboard_to_qmk.md
@@ -150,7 +150,7 @@ In the above example,
  * It must conform to the [layout guidelines](hardware_keyboard_guidelines.md#ltkeyboard_namehgt)
 * `"matrix": [0, 0]` defines the electrical position
 
-?> See also: [Split Keyboard Layout Macro](feature_split_keyboard?id=layout-macro) and [Matrix to Physical Layout](understanding_qmk?id=matrix-to-physical-layout-map).
+?> See also: [Split Keyboard Layout Macro](feature_split_keyboard.md#layout-macro) and [Matrix to Physical Layout](understanding_qmk.md#matrix-to-physical-layout-map).
 
 ## Additional Configuration
 

diff --git a/docs/pr_checklist.md b/docs/pr_checklist.md
@@ -122,9 +122,9 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard
 - `<keyboard>.c`
  - empty `xxxx_xxxx_kb()`, `xxxx_xxxx_user()`, or other weak-defined default implemented functions removed
  - commented-out functions removed too
- - `matrix_init_board()` etc. migrated to `keyboard_pre_init_kb()`, see: [keyboard_pre_init*](custom_quantum_functions.md?id=keyboard_pre_init_-function-documentation)
- - prefer `CUSTOM_MATRIX = lite` if custom matrix used, allows for standard debounce, see [custom matrix 'lite'](custom_matrix.md?id=lite)
- - prefer LED indicator [Configuration Options](feature_led_indicators.md?id=configuration-options) to custom `led_update_*()` implementations where possible
+ - `matrix_init_board()` etc. migrated to `keyboard_pre_init_kb()`, see: [keyboard_pre_init*](custom_quantum_functions.md#keyboard_pre_init_-function-documentation)
+ - prefer `CUSTOM_MATRIX = lite` if custom matrix used, allows for standard debounce, see [custom matrix 'lite'](custom_matrix.md#lite)
+ - prefer LED indicator [Configuration Options](feature_led_indicators.md#configuration-options) to custom `led_update_*()` implementations where possible
  - hardware that's enabled at the keyboard level and requires configuration such as OLED displays or encoders should have basic functionality implemented here
 - `<keyboard>.h`
  - `#include "quantum.h"` appears at the top
@@ -138,7 +138,7 @@ https://github.com/qmk/qmk_firmware/pulls?q=is%3Apr+is%3Aclosed+label%3Akeyboard
  - bare minimum to be used as a "clean slate" for another user to develop their own user-specific keymap
  - what does pristine mean? no custom keycodes. no advanced features like tap dance or macros. basic mod taps and home row mods would be acceptable where their use is necessary
  - standard layouts preferred in these keymaps, if possible
- - should use [encoder map feature](feature_encoders?id=encoder-map), rather than `encoder_update_user()`
+ - should use [encoder map feature](feature_encoders.md#encoder-map), rather than `encoder_update_user()`
  - default keymap should not enable VIA -- the VIA integration documentation requires a keymap called `via`
 - submitters can add an example (or bells-and-whistles) keymap showcasing capabilities in the same PR but it shouldn't be embedded in the 'default' keymap
 - submitters can also have a "manufacturer-matching" keymap that mirrors existing functionality of the commercial product, if porting an existing board
@@ -163,7 +163,7 @@ Also, specific to ChibiOS:
 - New board definitions must not be embedded in a keyboard PR
  - See [Core PRs](#core-pr) below for the procedure for adding a new board to QMK
 - if a board definition is unavoidable, `board.c` must have a standard `__early_init()` (as per normal ChibiOS board defs) and an empty `boardInit()`:
- - see Arm/ChibiOS [early initialization](platformdev_chibios_earlyinit.md?id=board-init)
+ - see Arm/ChibiOS [early initialization](platformdev_chibios_earlyinit.md#board-init)
  - `__early_init()` should be replaced by either `early_hardware_init_pre()` or `early_hardware_init_post()` as appropriate
  - `boardInit()` should be migrated to `board_init()`