diff options
| author | jack <jack@pngu.org> | 2024-09-06 10:30:54 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-09-06 17:30:54 +0100 |
| commit | f0435451446621a0e768c8a9123789b239a325b4 (patch) | |
| tree | 2edd6213e016497e5e962de52892e197d84ee282 | |
| parent | c44f5375ab6aa3ad98d48a8a32a973f8fe6ad20b (diff) | |
[Docs] Remove references to bootmagic lite (#24369)
| -rw-r--r-- | docs/_sidebar.json | 2 | ||||
| -rw-r--r-- | docs/config_options.md | 2 | ||||
| -rw-r--r-- | docs/driver_installation_zadig.md | 4 | ||||
| -rw-r--r-- | docs/faq_keymap.md | 2 | ||||
| -rw-r--r-- | docs/feature_eeprom.md | 2 | ||||
| -rw-r--r-- | docs/features/command.md | 2 | ||||
| -rw-r--r-- | docs/flashing.md | 4 | ||||
| -rw-r--r-- | docs/ref_functions.md | 2 | ||||
| -rw-r--r-- | docs/syllabus.md | 2 |
9 files changed, 11 insertions, 11 deletions
diff --git a/docs/_sidebar.json b/docs/_sidebar.json index 2ca62af92a..d691011d64 100644 --- a/docs/_sidebar.json +++ b/docs/_sidebar.json | |||
| @@ -167,7 +167,7 @@ | |||
| 167 | }, | 167 | }, |
| 168 | { "text": "Audio", "link": "/features/audio" }, | 168 | { "text": "Audio", "link": "/features/audio" }, |
| 169 | { "text": "Bluetooth", "link": "/features/bluetooth" }, | 169 | { "text": "Bluetooth", "link": "/features/bluetooth" }, |
| 170 | { "text": "Bootmagic Lite", "link": "/features/bootmagic" }, | 170 | { "text": "Bootmagic", "link": "/features/bootmagic" }, |
| 171 | { "text": "Converters", "link": "/feature_converters" }, | 171 | { "text": "Converters", "link": "/feature_converters" }, |
| 172 | { "text": "Custom Matrix", "link": "/custom_matrix" }, | 172 | { "text": "Custom Matrix", "link": "/custom_matrix" }, |
| 173 | { "text": "DIP Switch", "link": "/features/dip_switch" }, | 173 | { "text": "DIP Switch", "link": "/features/dip_switch" }, |
diff --git a/docs/config_options.md b/docs/config_options.md index a1ca8c8d50..fec6b22b13 100644 --- a/docs/config_options.md +++ b/docs/config_options.md | |||
| @@ -413,7 +413,7 @@ Use these to enable or disable building certain features. The more you have enab | |||
| 413 | * `MAGIC_ENABLE` | 413 | * `MAGIC_ENABLE` |
| 414 | * MAGIC actions (BOOTMAGIC without the boot) | 414 | * MAGIC actions (BOOTMAGIC without the boot) |
| 415 | * `BOOTMAGIC_ENABLE` | 415 | * `BOOTMAGIC_ENABLE` |
| 416 | * Enable Bootmagic Lite | 416 | * Enable Bootmagic |
| 417 | * `MOUSEKEY_ENABLE` | 417 | * `MOUSEKEY_ENABLE` |
| 418 | * Mouse keys | 418 | * Mouse keys |
| 419 | * `EXTRAKEY_ENABLE` | 419 | * `EXTRAKEY_ENABLE` |
diff --git a/docs/driver_installation_zadig.md b/docs/driver_installation_zadig.md index 099376faeb..9743c0adc2 100644 --- a/docs/driver_installation_zadig.md +++ b/docs/driver_installation_zadig.md | |||
| @@ -8,8 +8,8 @@ We recommend the use of the [Zadig](https://zadig.akeo.ie/) utility. If you have | |||
| 8 | 8 | ||
| 9 | ## Installation | 9 | ## Installation |
| 10 | 10 | ||
| 11 | Put your keyboard into bootloader mode, either by hitting the `QK_BOOT` keycode (which may be on a different layer), or by pressing the reset switch that's usually located on the underside of the board. If your keyboard has neither, try holding Escape or Space+`B` as you plug it in (see the [Bootmagic Lite](features/bootmagic) docs for more details). Some boards use [Command](features/command) instead of Bootmagic; in this case, you can enter bootloader mode by hitting Left Shift+Right Shift+`B` or Left Shift+Right Shift+Escape at any point while the keyboard is plugged in. | 11 | Put your keyboard into bootloader mode, either by hitting the `QK_BOOT` keycode (which may be on a different layer), or by pressing the reset switch that's usually located on the underside of the board. If your keyboard has neither, try holding Escape or Space+`B` as you plug it in (see the [Bootmagic](features/bootmagic) docs for more details). Some boards use [Command](features/command) instead of Bootmagic; in this case, you can enter bootloader mode by hitting Left Shift+Right Shift+`B` or Left Shift+Right Shift+Escape at any point while the keyboard is plugged in. |
| 12 | Some keyboards may have specific instructions for entering the bootloader. For example, the [Bootmagic Lite](features/bootmagic) key (default: Escape) might be on a different key, e.g. Left Control; or the magic combination for Command (default: Left Shift+Right Shift) might require you to hold something else, e.g. Left Control+Right Control. Refer to the board's README file if you are unsure. | 12 | Some keyboards may have specific instructions for entering the bootloader. For example, the [Bootmagic](features/bootmagic) key (default: Escape) might be on a different key, e.g. Left Control; or the magic combination for Command (default: Left Shift+Right Shift) might require you to hold something else, e.g. Left Control+Right Control. Refer to the board's README file if you are unsure. |
| 13 | 13 | ||
| 14 | To put a device in bootloader mode with USBaspLoader, tap the `RESET` button while holding down the `BOOT` button. | 14 | To put a device in bootloader mode with USBaspLoader, tap the `RESET` button while holding down the `BOOT` button. |
| 15 | Alternatively, hold `BOOT` while inserting the USB cable. | 15 | Alternatively, hold `BOOT` while inserting the USB cable. |
diff --git a/docs/faq_keymap.md b/docs/faq_keymap.md index 56ccc6f6cc..05bd4fed3e 100644 --- a/docs/faq_keymap.md +++ b/docs/faq_keymap.md | |||
| @@ -34,7 +34,7 @@ On first run, the VIA code in the firmware will copy the keymap from flash memor | |||
| 34 | 34 | ||
| 35 | The simple fix for this is to clear the EEPROM. You can do this in several ways: | 35 | The simple fix for this is to clear the EEPROM. You can do this in several ways: |
| 36 | 36 | ||
| 37 | * Hold the Bootmagic Lite key (usually top left/Escape) while plugging the board in, which will also place the board into bootloader mode; then unplug and replug the board. | 37 | * Hold the Bootmagic key (usually top left/Escape) while plugging the board in, which will also place the board into bootloader mode; then unplug and replug the board. |
| 38 | * Press the `QK_CLEAR_EEPROM`/`EE_CLR` keycode if it is accessible on your keymap. | 38 | * Press the `QK_CLEAR_EEPROM`/`EE_CLR` keycode if it is accessible on your keymap. |
| 39 | * Place the board into bootloader mode and hit the "Clear EEPROM" button. This may not be available for all bootloaders, and you may need to reflash the board afterwards. | 39 | * Place the board into bootloader mode and hit the "Clear EEPROM" button. This may not be available for all bootloaders, and you may need to reflash the board afterwards. |
| 40 | 40 | ||
diff --git a/docs/feature_eeprom.md b/docs/feature_eeprom.md index 2912407ac7..22257b3202 100644 --- a/docs/feature_eeprom.md +++ b/docs/feature_eeprom.md | |||
| @@ -109,7 +109,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) { | |||
| 109 | } | 109 | } |
| 110 | } | 110 | } |
| 111 | ``` | 111 | ``` |
| 112 | And lastly, you want to add the `eeconfig_init_user` function, so that when the EEPROM is reset, you can specify default values, and even custom actions. To force an EEPROM reset, use the `EE_CLR` keycode or [Bootmagic Lite](features/bootmagic) functionallity. For example, if you want to set rgb layer indication by default, and save the default valued. | 112 | And lastly, you want to add the `eeconfig_init_user` function, so that when the EEPROM is reset, you can specify default values, and even custom actions. To force an EEPROM reset, use the `EE_CLR` keycode or [Bootmagic](features/bootmagic) functionallity. For example, if you want to set rgb layer indication by default, and save the default valued. |
| 113 | 113 | ||
| 114 | ```c | 114 | ```c |
| 115 | void eeconfig_init_user(void) { // EEPROM is getting reset! | 115 | void eeconfig_init_user(void) { // EEPROM is getting reset! |
diff --git a/docs/features/command.md b/docs/features/command.md index 7ad45103c7..a6f96dcd83 100644 --- a/docs/features/command.md +++ b/docs/features/command.md | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | # Command | 1 | # Command |
| 2 | 2 | ||
| 3 | Command, formerly known as Magic, is a way to change your keyboard's behavior without having to flash or unplug it to use [Bootmagic Lite](bootmagic). There is a lot of overlap between this functionality and the [Magic Keycodes](../keycodes_magic). Wherever possible we encourage you to use that feature instead of Command. | 3 | Command, formerly known as Magic, is a way to change your keyboard's behavior without having to flash or unplug it to use [Bootmagic](bootmagic). There is a lot of overlap between this functionality and the [Magic Keycodes](../keycodes_magic). Wherever possible we encourage you to use that feature instead of Command. |
| 4 | 4 | ||
| 5 | On some keyboards Command is disabled by default. If this is the case, it must be explicitly enabled in your `rules.mk`: | 5 | On some keyboards Command is disabled by default. If this is the case, it must be explicitly enabled in your `rules.mk`: |
| 6 | 6 | ||
diff --git a/docs/flashing.md b/docs/flashing.md index 798331eb23..2afb858860 100644 --- a/docs/flashing.md +++ b/docs/flashing.md | |||
| @@ -53,7 +53,7 @@ QMK maintains [a fork of the LUFA DFU bootloader](https://github.com/qmk/lufa/tr | |||
| 53 | //#define QMK_LED E6 | 53 | //#define QMK_LED E6 |
| 54 | //#define QMK_SPEAKER C6 | 54 | //#define QMK_SPEAKER C6 |
| 55 | ``` | 55 | ``` |
| 56 | Currently we do not recommend making `QMK_ESC` the same key as the one designated for [Bootmagic Lite](features/bootmagic), as holding it down will cause the MCU to loop back and forth between entering and exiting the bootloader. | 56 | Currently we do not recommend making `QMK_ESC` the same key as the one designated for [Bootmagic](features/bootmagic), as holding it down will cause the MCU to loop back and forth between entering and exiting the bootloader. |
| 57 | 57 | ||
| 58 | The manufacturer and product strings are automatically pulled from `config.h`, with " Bootloader" appended to the product string. | 58 | The manufacturer and product strings are automatically pulled from `config.h`, with " Bootloader" appended to the product string. |
| 59 | 59 | ||
| @@ -209,7 +209,7 @@ To enable the additional features, add the following defines to your `config.h`: | |||
| 209 | //#define QMK_SPEAKER C6 | 209 | //#define QMK_SPEAKER C6 |
| 210 | ``` | 210 | ``` |
| 211 | 211 | ||
| 212 | Currently we do not recommend making `QMK_ESC` the same key as the one designated for [Bootmagic Lite](features/bootmagic), as holding it down will cause the MCU to loop back and forth between entering and exiting the bootloader. | 212 | Currently we do not recommend making `QMK_ESC` the same key as the one designated for [Bootmagic](features/bootmagic), as holding it down will cause the MCU to loop back and forth between entering and exiting the bootloader. |
| 213 | 213 | ||
| 214 | The manufacturer and product strings are automatically pulled from `config.h`, with " Bootloader" appended to the product string. | 214 | The manufacturer and product strings are automatically pulled from `config.h`, with " Bootloader" appended to the product string. |
| 215 | 215 | ||
diff --git a/docs/ref_functions.md b/docs/ref_functions.md index 577273c05d..3304981ef5 100644 --- a/docs/ref_functions.md +++ b/docs/ref_functions.md | |||
| @@ -99,7 +99,7 @@ To reset to the bootloader use `QK_BOOTLOADER` or `QK_BOOT` keycode or `reset_ke | |||
| 99 | 99 | ||
| 100 | ## Wiping the EEPROM (Persistent Storage) | 100 | ## Wiping the EEPROM (Persistent Storage) |
| 101 | 101 | ||
| 102 | If you're having issues with Audio, RGB Underglow, backlighting or keys acting weird, then you can reset the EEPROM (persistent setting storage). To force an EEPROM reset, use the [`EE_CLR` keycode](quantum_keycodes) or [Bootmagic Lite](features/bootmagic) functionality. If neither of those are an option, then you can use a custom macro to do so. | 102 | If you're having issues with Audio, RGB Underglow, backlighting or keys acting weird, then you can reset the EEPROM (persistent setting storage). To force an EEPROM reset, use the [`EE_CLR` keycode](quantum_keycodes) or [Bootmagic](features/bootmagic) functionality. If neither of those are an option, then you can use a custom macro to do so. |
| 103 | 103 | ||
| 104 | To wipe the EEPROM, run `eeconfig_init()` from your function or macro to reset most of the settings to default. | 104 | To wipe the EEPROM, run `eeconfig_init()` from your function or macro to reset most of the settings to default. |
| 105 | 105 | ||
diff --git a/docs/syllabus.md b/docs/syllabus.md index 3082f1ebd5..b68ded2d35 100644 --- a/docs/syllabus.md +++ b/docs/syllabus.md | |||
| @@ -55,7 +55,7 @@ Everything below here requires a lot of foundational knowledge. Besides being ab | |||
| 55 | * **Advanced Features** | 55 | * **Advanced Features** |
| 56 | * [Unicode](features/unicode) | 56 | * [Unicode](features/unicode) |
| 57 | * [API](api_overview) | 57 | * [API](api_overview) |
| 58 | * [Bootmagic Lite](features/bootmagic) | 58 | * [Bootmagic](features/bootmagic) |
| 59 | * **Hardware** | 59 | * **Hardware** |
| 60 | * [How Keyboards Work](how_keyboards_work) | 60 | * [How Keyboards Work](how_keyboards_work) |
| 61 | * [How A Keyboard Matrix Works](how_a_matrix_works) | 61 | * [How A Keyboard Matrix Works](how_a_matrix_works) |
