aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoel Challis <[email protected]>2025-07-23 13:08:48 +0100
committerGitHub <[email protected]>2025-07-23 13:08:48 +0100
commit36c3f4deba7e4c670736cc95db144b25156e90f1 (patch)
treed5faa6acc97cc430c0a09b1fe5e7841b40b01588
parent74d64c7f43a9a1a0f6a0a26c981f1611ac0edaa3 (diff)
downloadqmk_firmware-36c3f4deba7e4c670736cc95db144b25156e90f1.tar.gz
qmk_firmware-36c3f4deba7e4c670736cc95db144b25156e90f1.zip
[docs] Align more keyboard placeholders (#25510)
-rw-r--r--docs/drivers/aw20216s.md2
-rw-r--r--docs/drivers/is31fl3218.md2
-rw-r--r--docs/drivers/is31fl3236.md2
-rw-r--r--docs/drivers/is31fl3729.md2
-rw-r--r--docs/drivers/is31fl3731.md2
-rw-r--r--docs/drivers/is31fl3733.md2
-rw-r--r--docs/drivers/is31fl3736.md2
-rw-r--r--docs/drivers/is31fl3737.md2
-rw-r--r--docs/drivers/is31fl3741.md2
-rw-r--r--docs/drivers/is31fl3742a.md2
-rw-r--r--docs/drivers/is31fl3743a.md2
-rw-r--r--docs/drivers/is31fl3745.md2
-rw-r--r--docs/drivers/is31fl3746a.md2
-rw-r--r--docs/drivers/snled27351.md2
-rw-r--r--docs/getting_started_introduction.md4
-rw-r--r--docs/getting_started_make_guide.md4
-rw-r--r--docs/hardware_keyboard_guidelines.md4
17 files changed, 20 insertions, 20 deletions
diff --git a/docs/drivers/aw20216s.md b/docs/drivers/aw20216s.md
index 042c8df129..a8c87dd0f9 100644
--- a/docs/drivers/aw20216s.md
+++ b/docs/drivers/aw20216s.md
@@ -44,7 +44,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const aw20216s_led_t PROGMEM g_aw20216s_leds[AW20216S_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3218.md b/docs/drivers/is31fl3218.md
index 1c98069120..ccc70c3340 100644
--- a/docs/drivers/is31fl3218.md
+++ b/docs/drivers/is31fl3218.md
@@ -37,7 +37,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3218_led_t PROGMEM g_is31fl3218_leds[IS31FL3218_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3236.md b/docs/drivers/is31fl3236.md
index 98e05e4abd..83ce227203 100644
--- a/docs/drivers/is31fl3236.md
+++ b/docs/drivers/is31fl3236.md
@@ -50,7 +50,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3236_led_t PROGMEM g_is31fl3236_leds[IS31FL3236_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3729.md b/docs/drivers/is31fl3729.md
index 32618d82d5..1461874707 100644
--- a/docs/drivers/is31fl3729.md
+++ b/docs/drivers/is31fl3729.md
@@ -120,7 +120,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3729_led_t PROGMEM g_is31fl3729_leds[IS31FL3729_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3731.md b/docs/drivers/is31fl3731.md
index 0d928a919e..78b3d7b1ce 100644
--- a/docs/drivers/is31fl3731.md
+++ b/docs/drivers/is31fl3731.md
@@ -61,7 +61,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3731_led_t PROGMEM g_is31fl3731_leds[IS31FL3731_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3733.md b/docs/drivers/is31fl3733.md
index e299f785bd..13e9148a29 100644
--- a/docs/drivers/is31fl3733.md
+++ b/docs/drivers/is31fl3733.md
@@ -145,7 +145,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3733_led_t PROGMEM g_is31fl3733_leds[IS31FL3733_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3736.md b/docs/drivers/is31fl3736.md
index b679a232cd..e03275531c 100644
--- a/docs/drivers/is31fl3736.md
+++ b/docs/drivers/is31fl3736.md
@@ -129,7 +129,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3736_led_t PROGMEM g_is31fl3736_leds[IS31FL3736_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3737.md b/docs/drivers/is31fl3737.md
index d23def237f..e4663aa019 100644
--- a/docs/drivers/is31fl3737.md
+++ b/docs/drivers/is31fl3737.md
@@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3737_led_t PROGMEM g_is31fl3737_leds[IS31FL3737_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3741.md b/docs/drivers/is31fl3741.md
index dce5c08b21..b26262da7c 100644
--- a/docs/drivers/is31fl3741.md
+++ b/docs/drivers/is31fl3741.md
@@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3741_led_t PROGMEM g_is31fl3741_leds[IS31FL3741_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3742a.md b/docs/drivers/is31fl3742a.md
index ebe648cba4..e4f15162f6 100644
--- a/docs/drivers/is31fl3742a.md
+++ b/docs/drivers/is31fl3742a.md
@@ -117,7 +117,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3742a_led_t PROGMEM g_is31fl3742a_leds[IS31FL3742A_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3743a.md b/docs/drivers/is31fl3743a.md
index 9ca55c5eeb..b031edd5fb 100644
--- a/docs/drivers/is31fl3743a.md
+++ b/docs/drivers/is31fl3743a.md
@@ -127,7 +127,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3743a_led_t PROGMEM g_is31fl3743a_leds[IS31FL3743A_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3745.md b/docs/drivers/is31fl3745.md
index f13f029bfe..fb53dd3690 100644
--- a/docs/drivers/is31fl3745.md
+++ b/docs/drivers/is31fl3745.md
@@ -127,7 +127,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3745_led_t PROGMEM g_is31fl3745_leds[IS31FL3745_LED_COUNT] = {
diff --git a/docs/drivers/is31fl3746a.md b/docs/drivers/is31fl3746a.md
index bdd5c18357..19439a8a40 100644
--- a/docs/drivers/is31fl3746a.md
+++ b/docs/drivers/is31fl3746a.md
@@ -132,7 +132,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const is31fl3746a_led_t PROGMEM g_is31fl3746a_leds[IS31FL3746A_LED_COUNT] = {
diff --git a/docs/drivers/snled27351.md b/docs/drivers/snled27351.md
index 1d91182f7c..c0785711d9 100644
--- a/docs/drivers/snled27351.md
+++ b/docs/drivers/snled27351.md
@@ -52,7 +52,7 @@ Depending on the ChibiOS board configuration, you may need to [enable and config
## LED Mapping {#led-mapping}
-In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboardname>.c`:
+In order to use this driver, each output must be mapped to an LED index, by adding the following to your `<keyboard>.c`:
```c
const snled27351_led_t PROGMEM g_snled27351_leds[SNLED27351_LED_COUNT] = {
diff --git a/docs/getting_started_introduction.md b/docs/getting_started_introduction.md
index 9417351747..4a44e0e700 100644
--- a/docs/getting_started_introduction.md
+++ b/docs/getting_started_introduction.md
@@ -19,8 +19,8 @@ Within the folder `keyboards`, its subfolder `handwired` and its vendor and manu
* `config.h`: The file that sets the default compile time options. Do not edit this file directly, instead use a keymap specific `config.h`.
* `info.json`: The file used for setting layout for QMK Configurator. See [Configurator Support](reference_configurator_support) for more information.
* `readme.md`: A brief overview of the keyboard.
-* `<keyboardName>.h`: This file is where the keyboard layout is defined against the keyboard's switch matrix.
-* `<keyboardName>.c`: This file is where you can find custom code for the keyboard.
+* `<keyboard>.h`: This file is where the keyboard layout is defined against the keyboard's switch matrix.
+* `<keyboard>.c`: This file is where you can find custom code for the keyboard.
For more information on project structure, see [QMK Keyboard Guidelines](hardware_keyboard_guidelines).
diff --git a/docs/getting_started_make_guide.md b/docs/getting_started_make_guide.md
index 59455adb30..54f915e444 100644
--- a/docs/getting_started_make_guide.md
+++ b/docs/getting_started_make_guide.md
@@ -1,8 +1,8 @@
# More Detailed `make` Instructions
-The full syntax of the `make` command is `<keyboard_folder>:<keymap>:<target>`, where:
+The full syntax of the `make` command is `<keyboard>:<keymap>:<target>`, where:
-* `<keyboard_folder>` is the path of the keyboard, for example `planck`
+* `<keyboard>` is the path of the keyboard, for example `planck`
* Use `all` to compile all keyboards
* Specify the path to compile a revision, for example `planck/rev4` or `planck/rev3`
* If the keyboard doesn't have any folders, it can be left out
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md
index 4df443f9fc..0b8f35a373 100644
--- a/docs/hardware_keyboard_guidelines.md
+++ b/docs/hardware_keyboard_guidelines.md
@@ -203,7 +203,7 @@ The `post_rules.mk` file can interpret `features` of a keyboard-level before `co
See `build_keyboard.mk` and `common_features.mk` for more details.
:::
-### `<keyboard.c>`
+### `<keyboard>.c`
This file should contain C code required for the functionality of your keyboard, for example hardware initialisation code, OLED display code, and so on. This file should only contain code necessary for the keyboard to work, and *not* things that should be left to the end user to configure in their keymap. This file is automatically included in compilation if it exists. This is not a required file.
@@ -214,7 +214,7 @@ The following functions are typically defined in this file:
* `bool process_record_kb(uint16_t keycode, keyrecord_t *record)`
* `bool led_update_kb(led_t led_state)`
-### `<keyboard.h>`
+### `<keyboard>.h`
This file can contain function prototypes for custom functions and other header file code utilised by `<keyboard>.c`. The `<keyboard>.c` file should include this file. This is not a required file.