summaryrefslogtreecommitdiff
path: root/docs/ChangeLog
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2024-05-30 12:00:41 +1000
committerGitHub <noreply@github.com>2024-05-30 12:00:41 +1000
commit6ef97172889ccd5db376b2a9f8825489e24fdac4 (patch)
tree334e3bf41c8554d4bee73a140822f95f60eb64e9 /docs/ChangeLog
parent395766657ff98a4b1fd0dcba5917557f8acbb9e4 (diff)
Vitepress conversion of docs. (#23795)
Diffstat (limited to 'docs/ChangeLog')
-rw-r--r--docs/ChangeLog/20190830.md4
-rw-r--r--docs/ChangeLog/20200229.md2
-rw-r--r--docs/ChangeLog/20200829.md18
-rw-r--r--docs/ChangeLog/20201128.md16
-rw-r--r--docs/ChangeLog/20210529.md32
-rw-r--r--docs/ChangeLog/20210828.md30
-rw-r--r--docs/ChangeLog/20211127.md40
-rw-r--r--docs/ChangeLog/20220226.md14
-rw-r--r--docs/ChangeLog/20220528.md34
-rw-r--r--docs/ChangeLog/20220827.md32
-rw-r--r--docs/ChangeLog/20221126.md40
-rw-r--r--docs/ChangeLog/20230226.md20
-rw-r--r--docs/ChangeLog/20230528.md32
-rw-r--r--docs/ChangeLog/20230827.md22
-rw-r--r--docs/ChangeLog/20231126.md34
-rw-r--r--docs/ChangeLog/20240225.md26
-rw-r--r--docs/ChangeLog/20240526.md28
17 files changed, 217 insertions, 207 deletions
diff --git a/docs/ChangeLog/20190830.md b/docs/ChangeLog/20190830.md
index 298ec958c5..d6895216e9 100644
--- a/docs/ChangeLog/20190830.md
+++ b/docs/ChangeLog/20190830.md
@@ -20,7 +20,7 @@ This document marks the inaugural Breaking Change merge. A list of changes follo
20 20
21* `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` 21* `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()`
22* The end result of removing this obsolete feature should result in a decent reduction in firmware size and code complexity 22* The end result of removing this obsolete feature should result in a decent reduction in firmware size and code complexity
23* All keymaps affected are recommended to switch away from `fn_actions` in favour of the [custom keycode](https://docs.qmk.fm/#/custom_quantum_functions) and [macro](https://docs.qmk.fm/#/feature_macros) features 23* All keymaps affected are recommended to switch away from `fn_actions` in favour of the [custom keycode](../custom_quantum_functions) and [macro](../feature_macros) features
24 24
25## Update Atreus to current code conventions 25## Update Atreus to current code conventions
26 26
@@ -43,7 +43,7 @@ This document marks the inaugural Breaking Change merge. A list of changes follo
43 43
44* `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` 44* `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()`
45* All keymaps using these actions have had the relevant `KC_FN*` keys replaced with the equivalent `BL_*` keys 45* All keymaps using these actions have had the relevant `KC_FN*` keys replaced with the equivalent `BL_*` keys
46* If you currently use `KC_FN*` you will need to replace `fn_actions` with the [custom keycode](https://docs.qmk.fm/#/custom_quantum_functions) and [macro](https://docs.qmk.fm/#/feature_macros) features 46* If you currently use `KC_FN*` you will need to replace `fn_actions` with the [custom keycode](../custom_quantum_functions) and [macro](../feature_macros) features
47 47
48## Remove `KC_DELT` alias in favor of `KC_DEL` 48## Remove `KC_DELT` alias in favor of `KC_DEL`
49 49
diff --git a/docs/ChangeLog/20200229.md b/docs/ChangeLog/20200229.md
index 398fe01c0d..02bca3e371 100644
--- a/docs/ChangeLog/20200229.md
+++ b/docs/ChangeLog/20200229.md
@@ -51,7 +51,7 @@ Four times a year QMK runs a process for merging Breaking Changes. A Breaking Ch
51 51
52* `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()` 52* `fn_actions` is deprecated, and its functionality has been superseded by direct keycodes and `process_record_user()`
53* The end result of removing this obsolete feature should result in a decent reduction in firmware size and code complexity 53* The end result of removing this obsolete feature should result in a decent reduction in firmware size and code complexity
54* All keymaps affected are recommended to switch away from `fn_actions` in favour of the [custom keycode](https://docs.qmk.fm/#/custom_quantum_functions) and [macro](https://docs.qmk.fm/#/feature_macros) features 54* All keymaps affected are recommended to switch away from `fn_actions` in favour of the [custom keycode](../custom_quantum_functions) and [macro](../feature_macros) features
55 55
56 56
57## Moving backlight keycode handling to `process_keycode/` 57## Moving backlight keycode handling to `process_keycode/`
diff --git a/docs/ChangeLog/20200829.md b/docs/ChangeLog/20200829.md
index c6abed5b30..66957211f8 100644
--- a/docs/ChangeLog/20200829.md
+++ b/docs/ChangeLog/20200829.md
@@ -3,9 +3,9 @@
3Four times a year QMK runs a process for merging Breaking Changes. A Breaking Change is any change which modifies how QMK behaves in a way that is incompatible or potentially dangerous. We limit these changes to 4 times per year so that users can have confidence that updating their QMK tree will not break their keymaps. 3Four times a year QMK runs a process for merging Breaking Changes. A Breaking Change is any change which modifies how QMK behaves in a way that is incompatible or potentially dangerous. We limit these changes to 4 times per year so that users can have confidence that updating their QMK tree will not break their keymaps.
4 4
5 5
6## Changes Requiring User Action :id=changes-requiring-user-action 6## Changes Requiring User Action {#changes-requiring-user-action}
7 7
8### Relocated Keyboards :id=relocated-keyboards 8### Relocated Keyboards {#relocated-keyboards}
9 9
10#### The Key Company project consolidation ([#9547](https://github.com/qmk/qmk_firmware/pull/9547)) 10#### The Key Company project consolidation ([#9547](https://github.com/qmk/qmk_firmware/pull/9547))
11#### relocating boards by flehrad to flehrad/ folder ([#9635](https://github.com/qmk/qmk_firmware/pull/9635)) 11#### relocating boards by flehrad to flehrad/ folder ([#9635](https://github.com/qmk/qmk_firmware/pull/9635))
@@ -24,7 +24,7 @@ handwired/numbrero | flehrad/numbrero
24snagpad | flehrad/snagpad 24snagpad | flehrad/snagpad
25handwired/tradestation | flehrad/tradestation 25handwired/tradestation | flehrad/tradestation
26 26
27### Updated Keyboard Codebases :id=keyboard-updates 27### Updated Keyboard Codebases {#keyboard-updates}
28 28
29#### Keebio RGB wiring update ([#7754](https://github.com/qmk/qmk_firmware/pull/7754)) 29#### Keebio RGB wiring update ([#7754](https://github.com/qmk/qmk_firmware/pull/7754))
30 30
@@ -46,7 +46,7 @@ This change affects:
46* Quefrency rev1 46* Quefrency rev1
47* Viterbi, revs. 1 and 2 47* Viterbi, revs. 1 and 2
48 48
49### Changes to Core Functionality :id=core-updates 49### Changes to Core Functionality {#core-updates}
50 50
51* Bigger Combo index ([#9318](https://github.com/qmk/qmk_firmware/pull/9318)) 51* Bigger Combo index ([#9318](https://github.com/qmk/qmk_firmware/pull/9318))
52 52
@@ -58,14 +58,14 @@ Any fork that uses `process_combo_event` needs to update the function's first ar
58* New function: `void process_combo_event(uint16_t combo_index, bool pressed)` 58* New function: `void process_combo_event(uint16_t combo_index, bool pressed)`
59 59
60 60
61## Core Changes :id=core-changes 61## Core Changes {#core-changes}
62 62
63### Fixes :id=core-fixes 63### Fixes {#core-fixes}
64 64
65* Mousekeys: scrolling acceleration is no longer coupled to mouse movement acceleration ([#9174](https://github.com/qmk/qmk_firmware/pull/9174)) 65* Mousekeys: scrolling acceleration is no longer coupled to mouse movement acceleration ([#9174](https://github.com/qmk/qmk_firmware/pull/9174))
66* Keymap Extras: correctly assign Question Mark in Czech layout ([#9987](https://github.com/qmk/qmk_firmware/pull/9987)) 66* Keymap Extras: correctly assign Question Mark in Czech layout ([#9987](https://github.com/qmk/qmk_firmware/pull/9987))
67 67
68### Additions and Enhancements :id=core-additions 68### Additions and Enhancements {#core-additions}
69 69
70* allow for WS2812 PWM to work on DMAMUX-capable devices ([#9471](https://github.com/qmk/qmk_firmware/pull/9471)) 70* allow for WS2812 PWM to work on DMAMUX-capable devices ([#9471](https://github.com/qmk/qmk_firmware/pull/9471))
71 * Newer STM32 MCUs have a DMAMUX peripheral, which allows mapping of DMAs to different DMA streams, rather than hard-defining the target streams in silicon. 71 * Newer STM32 MCUs have a DMAMUX peripheral, which allows mapping of DMAs to different DMA streams, rather than hard-defining the target streams in silicon.
@@ -109,7 +109,7 @@ Any fork that uses `process_combo_event` needs to update the function's first ar
109 * The K-Type has been refactored to use QMK's native matrix scanning routine, and now has partial support for the RGB Matrix feature. 109 * The K-Type has been refactored to use QMK's native matrix scanning routine, and now has partial support for the RGB Matrix feature.
110* Joysticks can now be used without defining analog pins ([#10169](https://github.com/qmk/qmk_firmware/pull/10169)) 110* Joysticks can now be used without defining analog pins ([#10169](https://github.com/qmk/qmk_firmware/pull/10169))
111 111
112### Clean-ups and Optimizations :id=core-optimizations 112### Clean-ups and Optimizations {#core-optimizations}
113 113
114* iWRAP protocol removed ([#9284](https://github.com/qmk/qmk_firmware/pull/9284)) 114* iWRAP protocol removed ([#9284](https://github.com/qmk/qmk_firmware/pull/9284))
115* work begun for consolidation of ChibiOS platform files ([#8327](https://github.com/qmk/qmk_firmware/pull/8327) and [#9315](https://github.com/qmk/qmk_firmware/pull/9315)) 115* work begun for consolidation of ChibiOS platform files ([#8327](https://github.com/qmk/qmk_firmware/pull/8327) and [#9315](https://github.com/qmk/qmk_firmware/pull/9315))
@@ -140,7 +140,7 @@ Any fork that uses `process_combo_event` needs to update the function's first ar
140* remove support for Adafruit EZ Key Bluetooth controller ([#10103](https://github.com/qmk/qmk_firmware/pull/10103)) 140* remove support for Adafruit EZ Key Bluetooth controller ([#10103](https://github.com/qmk/qmk_firmware/pull/10103))
141 141
142 142
143## QMK Infrastructure and Internals :id=qmk-internals 143## QMK Infrastructure and Internals {#qmk-internals}
144 144
145* Attempt to fix CI for non-master branches. ([#9308](https://github.com/qmk/qmk_firmware/pull/9308)) 145* Attempt to fix CI for non-master branches. ([#9308](https://github.com/qmk/qmk_firmware/pull/9308))
146 * Actually fetch the branch we're attempting to compare against. 146 * Actually fetch the branch we're attempting to compare against.
diff --git a/docs/ChangeLog/20201128.md b/docs/ChangeLog/20201128.md
index 4441320295..d005d3b56b 100644
--- a/docs/ChangeLog/20201128.md
+++ b/docs/ChangeLog/20201128.md
@@ -3,9 +3,9 @@
3Four times a year QMK runs a process for merging Breaking Changes. A Breaking Change is any change which modifies how QMK behaves in a way that is incompatible or potentially dangerous. We limit these changes to 4 times per year so that users can have confidence that updating their QMK tree will not break their keymaps. 3Four times a year QMK runs a process for merging Breaking Changes. A Breaking Change is any change which modifies how QMK behaves in a way that is incompatible or potentially dangerous. We limit these changes to 4 times per year so that users can have confidence that updating their QMK tree will not break their keymaps.
4 4
5 5
6## Changes Requiring User Action :id=changes-requiring-user-action 6## Changes Requiring User Action {#changes-requiring-user-action}
7 7
8### Relocated Keyboards :id=relocated-keyboards 8### Relocated Keyboards {#relocated-keyboards}
9 9
10#### Reduce Helix keyboard build variation ([#8669](https://github.com/qmk/qmk_firmware/pull/8669)) 10#### Reduce Helix keyboard build variation ([#8669](https://github.com/qmk/qmk_firmware/pull/8669))
11 11
@@ -88,21 +88,21 @@ The Valor and Dawn60 keyboards by Xelus22 both now require their revisions to be
88| xelus/valor | xelus/valor/rev1 | 88| xelus/valor | xelus/valor/rev1 |
89 89
90 90
91### Updated Keyboard Codebases :id=keyboard-updates 91### Updated Keyboard Codebases {#keyboard-updates}
92 92
93#### AEboards EXT65 Refactor ([#10820](https://github.com/qmk/qmk_firmware/pull/10820)) 93#### AEboards EXT65 Refactor ([#10820](https://github.com/qmk/qmk_firmware/pull/10820))
94 94
95The EXT65 codebase has been reworked so keymaps can be used with either revision. 95The EXT65 codebase has been reworked so keymaps can be used with either revision.
96 96
97 97
98## Core Changes :id=core-changes 98## Core Changes {#core-changes}
99 99
100### Fixes :id=core-fixes 100### Fixes {#core-fixes}
101 101
102* Reconnect the USB if users wake up a computer from the keyboard to restore the USB state ([#10088](https://github.com/qmk/qmk_firmware/pull/10088)) 102* Reconnect the USB if users wake up a computer from the keyboard to restore the USB state ([#10088](https://github.com/qmk/qmk_firmware/pull/10088))
103* Fix cursor position bug in oled_write_raw functions ([#10800](https://github.com/qmk/qmk_firmware/pull/10800)) 103* Fix cursor position bug in oled_write_raw functions ([#10800](https://github.com/qmk/qmk_firmware/pull/10800))
104 104
105### Additions and Enhancements :id=core-additions 105### Additions and Enhancements {#core-additions}
106 106
107* Allow MATRIX_ROWS to be greater than 32 ([#10183](https://github.com/qmk/qmk_firmware/pull/10183)) 107* Allow MATRIX_ROWS to be greater than 32 ([#10183](https://github.com/qmk/qmk_firmware/pull/10183))
108* Add support for soft serial to ATmega32U2 ([#10204](https://github.com/qmk/qmk_firmware/pull/10204)) 108* Add support for soft serial to ATmega32U2 ([#10204](https://github.com/qmk/qmk_firmware/pull/10204))
@@ -119,7 +119,7 @@ The EXT65 codebase has been reworked so keymaps can be used with either revision
119* Add AT90USB support for serial.c ([#10706](https://github.com/qmk/qmk_firmware/pull/10706)) 119* Add AT90USB support for serial.c ([#10706](https://github.com/qmk/qmk_firmware/pull/10706))
120* Auto shift: support repeats and early registration (#9826) 120* Auto shift: support repeats and early registration (#9826)
121 121
122### Clean-ups and Optimizations :id=core-optimizations 122### Clean-ups and Optimizations {#core-optimizations}
123 123
124* Haptic and solenoid cleanup ([#9700](https://github.com/qmk/qmk_firmware/pull/9700)) 124* Haptic and solenoid cleanup ([#9700](https://github.com/qmk/qmk_firmware/pull/9700))
125* XD75 cleanup ([#10524](https://github.com/qmk/qmk_firmware/pull/10524)) 125* XD75 cleanup ([#10524](https://github.com/qmk/qmk_firmware/pull/10524))
@@ -129,7 +129,7 @@ The EXT65 codebase has been reworked so keymaps can be used with either revision
129* Remove references to HD44780 ([#10735](https://github.com/qmk/qmk_firmware/pull/10735)) 129* Remove references to HD44780 ([#10735](https://github.com/qmk/qmk_firmware/pull/10735))
130 130
131 131
132## QMK Infrastructure and Internals :id=qmk-internals 132## QMK Infrastructure and Internals {#qmk-internals}
133 133
134* Add ability to build a subset of all keyboards based on platform. ([#10420](https://github.com/qmk/qmk_firmware/pull/10420)) 134* Add ability to build a subset of all keyboards based on platform. ([#10420](https://github.com/qmk/qmk_firmware/pull/10420))
135* Initialise EEPROM drivers at startup, instead of upon first execution ([#10438](https://github.com/qmk/qmk_firmware/pull/10438)) 135* Initialise EEPROM drivers at startup, instead of upon first execution ([#10438](https://github.com/qmk/qmk_firmware/pull/10438))
diff --git a/docs/ChangeLog/20210529.md b/docs/ChangeLog/20210529.md
index 2feeed6437..69923b0c5a 100644
--- a/docs/ChangeLog/20210529.md
+++ b/docs/ChangeLog/20210529.md
@@ -1,30 +1,30 @@
1# QMK Breaking Changes - 2021 May 29 Changelog 1# QMK Breaking Changes - 2021 May 29 Changelog
2 2
3## Notable Changes :id=notable-changes 3## Notable Changes {#notable-changes}
4 4
5### RGB Matrix support for split common ([#11055](https://github.com/qmk/qmk_firmware/pull/11055)) :id=rgb-matrix-split-common 5### RGB Matrix support for split common ([#11055](https://github.com/qmk/qmk_firmware/pull/11055)) {#rgb-matrix-split-common}
6 6
7Split boards can now use RGB Matrix without defining a custom matrix. 7Split boards can now use RGB Matrix without defining a custom matrix.
8 8
9### Teensy 3.6 support ([#12258](https://github.com/qmk/qmk_firmware/pull/12258)) :id=teensy-3-6-support 9### Teensy 3.6 support ([#12258](https://github.com/qmk/qmk_firmware/pull/12258)) {#teensy-3-6-support}
10 10
11Added support for MK66F18 (Teensy 3.6) microcontroller. 11Added support for MK66F18 (Teensy 3.6) microcontroller.
12 12
13### New command: qmk console ([#12828](https://github.com/qmk/qmk_firmware/pull/12828)) :id=new-command-qmk-console 13### New command: qmk console ([#12828](https://github.com/qmk/qmk_firmware/pull/12828)) {#new-command-qmk-console}
14 14
15A new `qmk console` command has been added for attaching to your keyboard's console. It operates similiarly to QMK Toolbox by allowing you to connect to one or more keyboard consoles to display debugging messages. 15A new `qmk console` command has been added for attaching to your keyboard's console. It operates similiarly to QMK Toolbox by allowing you to connect to one or more keyboard consoles to display debugging messages.
16 16
17### Improved command: qmk config :id=improve-command-qmk-config 17### Improved command: qmk config {#improve-command-qmk-config}
18 18
19We've updated the `qmk config` command to show only the configuration items you have actually set. You can now display (almost) all of the available configuration options, along with their default values, using `qmk config -a`. 19We've updated the `qmk config` command to show only the configuration items you have actually set. You can now display (almost) all of the available configuration options, along with their default values, using `qmk config -a`.
20 20
21### LED Matrix Improvements ([#12509](https://github.com/qmk/qmk_firmware/pull/12509), [#12580](https://github.com/qmk/qmk_firmware/pull/12580), [#12588](https://github.com/qmk/qmk_firmware/pull/12588), [#12633](https://github.com/qmk/qmk_firmware/pull/12633), [#12651](https://github.com/qmk/qmk_firmware/pull/12651), [#12685](https://github.com/qmk/qmk_firmware/pull/12685)) :id=led-matrix-improvements 21### LED Matrix Improvements ([#12509](https://github.com/qmk/qmk_firmware/pull/12509), [#12580](https://github.com/qmk/qmk_firmware/pull/12580), [#12588](https://github.com/qmk/qmk_firmware/pull/12588), [#12633](https://github.com/qmk/qmk_firmware/pull/12633), [#12651](https://github.com/qmk/qmk_firmware/pull/12651), [#12685](https://github.com/qmk/qmk_firmware/pull/12685)) {#led-matrix-improvements}
22 22
23LED Matrix has been improved with effects, CIE1931 curves, and a task system. 23LED Matrix has been improved with effects, CIE1931 curves, and a task system.
24 24
25## Changes Requiring User Action :id=changes-requiring-user-action 25## Changes Requiring User Action {#changes-requiring-user-action}
26 26
27### Updated Keyboard Codebases :id=updated-keyboard-codebases 27### Updated Keyboard Codebases {#updated-keyboard-codebases}
28 28
29* Durgod keyboard refactor in preparation for adding additional durgod keyboards ([#11978](https://github.com/qmk/qmk_firmware/pull/11978)) 29* Durgod keyboard refactor in preparation for adding additional durgod keyboards ([#11978](https://github.com/qmk/qmk_firmware/pull/11978))
30* Updated Function96 with V2 files and removed chconf.h and halconf.h ([#12613](https://github.com/qmk/qmk_firmware/pull/12613)) 30* Updated Function96 with V2 files and removed chconf.h and halconf.h ([#12613](https://github.com/qmk/qmk_firmware/pull/12613))
@@ -52,7 +52,7 @@ The codebase for the [Durgod K320](https://github.com/qmk/qmk_firmware/tree/0.13
52 52
53Additionally, the `crkbd/rev1/legacy` keyboard has been removed. 53Additionally, the `crkbd/rev1/legacy` keyboard has been removed.
54 54
55### Bootmagic Deprecation and Refactor ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) :id=bootmagic-deprecation-and-refactor 55### Bootmagic Deprecation and Refactor ([#12172](https://github.com/qmk/qmk_firmware/pull/12172)) {#bootmagic-deprecation-and-refactor}
56 56
57QMK has decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option. 57QMK has decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option.
58 58
@@ -68,11 +68,11 @@ This is the current planned roadmap for the behavior of `BOOTMAGIC_ENABLE`:
68- From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail. 68- From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail.
69- From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail. 69- From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail.
70 70
71### Removal of LAYOUT_kc ([#12160](https://github.com/qmk/qmk_firmware/pull/12160)) :id=removal-of-layout-kc 71### Removal of LAYOUT_kc ([#12160](https://github.com/qmk/qmk_firmware/pull/12160)) {#removal-of-layout-kc}
72 72
73We've removed support for `LAYOUT_kc` macros, if your keymap uses one you will need to update it use a regular `LAYOUT` macro. 73We've removed support for `LAYOUT_kc` macros, if your keymap uses one you will need to update it use a regular `LAYOUT` macro.
74 74
75### Encoder callbacks are now boolean ([#12805](https://github.com/qmk/qmk_firmware/pull/12805), [#12985](https://github.com/qmk/qmk_firmware/pull/12985)) :id=encoder-callback-boolean 75### Encoder callbacks are now boolean ([#12805](https://github.com/qmk/qmk_firmware/pull/12805), [#12985](https://github.com/qmk/qmk_firmware/pull/12985)) {#encoder-callback-boolean}
76 76
77To allow for keyboards to override (or not) keymap level code the `encoder_update_kb` function has been changed from `void` to `bool`. You will need to update your function definition to reflect this and ensure that you return a `true` or `false` value. 77To allow for keyboards to override (or not) keymap level code the `encoder_update_kb` function has been changed from `void` to `bool`. You will need to update your function definition to reflect this and ensure that you return a `true` or `false` value.
78 78
@@ -127,9 +127,9 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
127} 127}
128``` 128```
129 129
130## Core Changes :id=core-changes 130## Core Changes {#core-changes}
131 131
132### Fixes :id=core-fixes 132### Fixes {#core-fixes}
133 133
134* Fix connection issue in split keyboards when slave and OLED display are connected via I2C (fixes #9335) ([#11487](https://github.com/qmk/qmk_firmware/pull/11487)) 134* Fix connection issue in split keyboards when slave and OLED display are connected via I2C (fixes #9335) ([#11487](https://github.com/qmk/qmk_firmware/pull/11487))
135* Terrazzo: Fix wrong LED Matrix function names ([#12561](https://github.com/qmk/qmk_firmware/pull/12561)) 135* Terrazzo: Fix wrong LED Matrix function names ([#12561](https://github.com/qmk/qmk_firmware/pull/12561))
@@ -147,7 +147,7 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
147* [Keyboard] Fix Terrazzo build failure ([#12977](https://github.com/qmk/qmk_firmware/pull/12977)) 147* [Keyboard] Fix Terrazzo build failure ([#12977](https://github.com/qmk/qmk_firmware/pull/12977))
148* Do not hard set config in CPTC files ([#11864](https://github.com/qmk/qmk_firmware/pull/11864)) 148* Do not hard set config in CPTC files ([#11864](https://github.com/qmk/qmk_firmware/pull/11864))
149 149
150### Additions and Enhancements :id=core-additions 150### Additions and Enhancements {#core-additions}
151 151
152* ARM - Refactor SLEEP_LED to support more platforms ([#8403](https://github.com/qmk/qmk_firmware/pull/8403)) 152* ARM - Refactor SLEEP_LED to support more platforms ([#8403](https://github.com/qmk/qmk_firmware/pull/8403))
153* Add ability to toggle One Shot functionality ([#4198](https://github.com/qmk/qmk_firmware/pull/4198)) 153* Add ability to toggle One Shot functionality ([#4198](https://github.com/qmk/qmk_firmware/pull/4198))
@@ -193,7 +193,7 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
193* Backlight: add defines for default level and breathing state ([#12560](https://github.com/qmk/qmk_firmware/pull/12560), [#13024](https://github.com/qmk/qmk_firmware/pull/13024)) 193* Backlight: add defines for default level and breathing state ([#12560](https://github.com/qmk/qmk_firmware/pull/12560), [#13024](https://github.com/qmk/qmk_firmware/pull/13024))
194* Add dire message about LUFA mass storage bootloader ([#13014](https://github.com/qmk/qmk_firmware/pull/13014)) 194* Add dire message about LUFA mass storage bootloader ([#13014](https://github.com/qmk/qmk_firmware/pull/13014))
195 195
196### Clean-ups and Optimizations :id=core-optimizations 196### Clean-ups and Optimizations {#core-optimizations}
197 197
198* Overhaul bootmagic logic to have single entrypoint ([#8532](https://github.com/qmk/qmk_firmware/pull/8532)) 198* Overhaul bootmagic logic to have single entrypoint ([#8532](https://github.com/qmk/qmk_firmware/pull/8532))
199* Refactor of USB code within split_common ([#11890](https://github.com/qmk/qmk_firmware/pull/11890)) 199* Refactor of USB code within split_common ([#11890](https://github.com/qmk/qmk_firmware/pull/11890))
@@ -218,7 +218,7 @@ bool encoder_update_user(uint8_t index, bool clockwise) {
218* Deprecate `send_unicode_hex_string()` ([#12602](https://github.com/qmk/qmk_firmware/pull/12602)) 218* Deprecate `send_unicode_hex_string()` ([#12602](https://github.com/qmk/qmk_firmware/pull/12602))
219* [Keyboard] Remove redundant legacy and common headers for crkbd ([#13023](https://github.com/qmk/qmk_firmware/pull/13023)) 219* [Keyboard] Remove redundant legacy and common headers for crkbd ([#13023](https://github.com/qmk/qmk_firmware/pull/13023))
220 220
221### QMK Infrastructure and Internals :id=qmk-internals 221### QMK Infrastructure and Internals {#qmk-internals}
222 222
223* trivial change to trigger api update ([`b15288fb87`](https://github.com/qmk/qmk_firmware/commit/b15288fb87)) 223* trivial change to trigger api update ([`b15288fb87`](https://github.com/qmk/qmk_firmware/commit/b15288fb87))
224* fix some references to bin/qmk that slipped in ([#12832](https://github.com/qmk/qmk_firmware/pull/12832)) 224* fix some references to bin/qmk that slipped in ([#12832](https://github.com/qmk/qmk_firmware/pull/12832))
diff --git a/docs/ChangeLog/20210828.md b/docs/ChangeLog/20210828.md
index f96283e6ad..f84169cc94 100644
--- a/docs/ChangeLog/20210828.md
+++ b/docs/ChangeLog/20210828.md
@@ -1,28 +1,28 @@
1# QMK Breaking Changes - 2021 August 28 Changelog 1# QMK Breaking Changes - 2021 August 28 Changelog
2 2
3## Notable Features :id=notable-features 3## Notable Features {#notable-features}
4 4
5### Combo processing improvements ([#8591](https://github.com/qmk/qmk_firmware/pull/8591)) :id=combo-processing-improvements 5### Combo processing improvements ([#8591](https://github.com/qmk/qmk_firmware/pull/8591)) {#combo-processing-improvements}
6 6
7Combo processing has been reordered with respect to keypress handling, allowing for much better compatibility with mod taps. 7Combo processing has been reordered with respect to keypress handling, allowing for much better compatibility with mod taps.
8 8
9It is also now possible to define combos that have keys overlapping with other combos, triggering only one. For example, a combo of `A`, `B` can coexist with a longer combo of `A`, `B`, `C` -- previous functionality would trigger both combos if all three keys were pressed. 9It is also now possible to define combos that have keys overlapping with other combos, triggering only one. For example, a combo of `A`, `B` can coexist with a longer combo of `A`, `B`, `C` -- previous functionality would trigger both combos if all three keys were pressed.
10 10
11### Key Overrides ([#11422](https://github.com/qmk/qmk_firmware/pull/11422)) :id=key-overrides 11### Key Overrides ([#11422](https://github.com/qmk/qmk_firmware/pull/11422)) {#key-overrides}
12 12
13QMK now has a new feature: [key overrides](https://docs.qmk.fm/#/feature_key_overrides). This feature allows for overriding the output of key combinations involving modifiers. As an example, pressing <kbd>Shift+2</kbd> normally results in an <kbd>@</kbd> on US-ANSI keyboard layouts -- the new key overrides allow for adding similar functionality, but for any <kbd>modifier + key</kbd> press. 13QMK now has a new feature: [key overrides](../feature_key_overrides). This feature allows for overriding the output of key combinations involving modifiers. As an example, pressing <kbd>Shift+2</kbd> normally results in an <kbd>@</kbd> on US-ANSI keyboard layouts -- the new key overrides allow for adding similar functionality, but for any <kbd>modifier + key</kbd> press.
14 14
15To illustrate, it's now possible to use the key overrides feature to translate <kbd>Shift + Backspace</kbd> into <kbd>Delete</kbd> -- an often-requested example of where this functionality comes in handy. 15To illustrate, it's now possible to use the key overrides feature to translate <kbd>Shift + Backspace</kbd> into <kbd>Delete</kbd> -- an often-requested example of where this functionality comes in handy.
16 16
17There's far more to describe that what lives in this changelog, so head over to the [key overrides documentation](https://docs.qmk.fm/#/feature_key_overrides) for more examples and info. 17There's far more to describe that what lives in this changelog, so head over to the [key overrides documentation](../feature_key_overrides) for more examples and info.
18 18
19### Digitizer support ([#12851](https://github.com/qmk/qmk_firmware/pull/12851)) 19### Digitizer support ([#12851](https://github.com/qmk/qmk_firmware/pull/12851))
20 20
21QMK gained the ability to pretend to be a digitizer device -- much like a tablet device. A mouse uses delta-coordinates -- move up, move right -- but a digitizer works with absolute coordinates -- top left, bottom right. 21QMK gained the ability to pretend to be a digitizer device -- much like a tablet device. A mouse uses delta-coordinates -- move up, move right -- but a digitizer works with absolute coordinates -- top left, bottom right.
22 22
23## Changes Requiring User Action :id=changes-requiring-user-action 23## Changes Requiring User Action {#changes-requiring-user-action}
24 24
25### Updated Keyboard Codebases :id=updated-keyboard-codebases 25### Updated Keyboard Codebases {#updated-keyboard-codebases}
26 26
27The following keyboards have had their source moved within QMK: 27The following keyboards have had their source moved within QMK:
28 28
@@ -69,7 +69,7 @@ xd84pro | xiudi/xd84pro
69xd87 | xiudi/xd87 69xd87 | xiudi/xd87
70xd96 | xiudi/xd96 70xd96 | xiudi/xd96
71 71
72### Bootmagic Full Removal ([#13846](https://github.com/qmk/qmk_firmware/pull/13846)) :id=bootmagic-full-removal 72### Bootmagic Full Removal ([#13846](https://github.com/qmk/qmk_firmware/pull/13846)) {#bootmagic-full-removal}
73 73
74As noted during last breaking changes cycle, QMK has decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option. 74As noted during last breaking changes cycle, QMK has decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option.
75 75
@@ -85,7 +85,7 @@ This is the current roadmap for the behavior of `BOOTMAGIC_ENABLE`:
85- (now) From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail. 85- (now) From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail.
86- (next) From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail. 86- (next) From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail.
87 87
88### DIP switch callbacks are now boolean ([#13399](https://github.com/qmk/qmk_firmware/pull/13399)) :id=dip-switch-boolean 88### DIP switch callbacks are now boolean ([#13399](https://github.com/qmk/qmk_firmware/pull/13399)) {#dip-switch-boolean}
89 89
90To match the encoder change last breaking changes cycle, DIP switch callbacks now return `bool`, too. 90To match the encoder change last breaking changes cycle, DIP switch callbacks now return `bool`, too.
91 91
@@ -149,9 +149,9 @@ bool dip_switch_update_mask_user(uint32_t state) {
149} 149}
150``` 150```
151 151
152## Notable core changes :id=notable-core 152## Notable core changes {#notable-core}
153 153
154### Split transport improvements :id=split-transport-improvements 154### Split transport improvements {#split-transport-improvements}
155 155
156Split keyboards gained a significant amount of improvements during this breaking changes cycle, specifically: 156Split keyboards gained a significant amount of improvements during this breaking changes cycle, specifically:
157 157
@@ -160,9 +160,11 @@ Split keyboards gained a significant amount of improvements during this breaking
160* Make solo half of split keyboards (more) usable. ([#13523](https://github.com/qmk/qmk_firmware/pull/13523)) -- allows the slave to be disconnected, enabling one-handed use. 160* Make solo half of split keyboards (more) usable. ([#13523](https://github.com/qmk/qmk_firmware/pull/13523)) -- allows the slave to be disconnected, enabling one-handed use.
161* Switch split_common to CRC subsystem ([#13418](https://github.com/qmk/qmk_firmware/pull/13418)) 161* Switch split_common to CRC subsystem ([#13418](https://github.com/qmk/qmk_firmware/pull/13418))
162 162
163!> If you're updating your split keyboard, you will need to flash both sides of the split with the your firmware. 163::: warning
164If you're updating your split keyboard, you will need to flash both sides of the split with the your firmware.
165:::
164 166
165### Teensy 4.x support ([#13056](https://github.com/qmk/qmk_firmware/pull/13056), [#13076](https://github.com/qmk/qmk_firmware/pull/13076), [#13077](https://github.com/qmk/qmk_firmware/pull/13077)) :id=teensy-4-x-support 167### Teensy 4.x support ([#13056](https://github.com/qmk/qmk_firmware/pull/13056), [#13076](https://github.com/qmk/qmk_firmware/pull/13076), [#13077](https://github.com/qmk/qmk_firmware/pull/13077)) {#teensy-4-x-support}
166 168
167Updated ChibiOS and ChibiOS-Contrib, which brought in support for Teensy 4.x dev boards, running NXP i.MX1062. 169Updated ChibiOS and ChibiOS-Contrib, which brought in support for Teensy 4.x dev boards, running NXP i.MX1062.
168 170
@@ -243,7 +245,7 @@ We've added dozens of new keys to `info.json` so that you can configure more tha
243* `usb.force_nkro`, `usb.max_power`, `usb.no_startup_check`, `usb.polling_interval`, `usb.shared_endpoint.keyboard`, `usb.shared_endpoint.mouse`, `usb.suspend_wakeup_delay`, `usb.wait_for` 245* `usb.force_nkro`, `usb.max_power`, `usb.no_startup_check`, `usb.polling_interval`, `usb.shared_endpoint.keyboard`, `usb.shared_endpoint.mouse`, `usb.suspend_wakeup_delay`, `usb.wait_for`
244* `qmk.keys_per_scan`, `qmk.tap_keycode_delay`, `qmk.tap_capslock_delay` 246* `qmk.keys_per_scan`, `qmk.tap_keycode_delay`, `qmk.tap_capslock_delay`
245 247
246### Codebase restructure and cleanup :id=codebase-restructure 248### Codebase restructure and cleanup {#codebase-restructure}
247 249
248QMK was originally based on TMK, and has grown in size considerably since its first inception. To keep moving things forward, restructure of some of the core areas of the code is needed to support new concepts and new hardware, and progress is happening along those lines: 250QMK was originally based on TMK, and has grown in size considerably since its first inception. To keep moving things forward, restructure of some of the core areas of the code is needed to support new concepts and new hardware, and progress is happening along those lines:
249 251
diff --git a/docs/ChangeLog/20211127.md b/docs/ChangeLog/20211127.md
index 0780ab6a44..d810be505a 100644
--- a/docs/ChangeLog/20211127.md
+++ b/docs/ChangeLog/20211127.md
@@ -1,6 +1,6 @@
1# QMK Breaking Changes - 2021 November 27 Changelog 1# QMK Breaking Changes - 2021 November 27 Changelog
2 2
3## 2000 keyboards! :id=qmk-2000th-keyboard 3## 2000 keyboards! {#qmk-2000th-keyboard}
4 4
5QMK had it's 2000th keyboard submitted during this breaking changes cycle.... and it only _just_ made the cut-off! 5QMK had it's 2000th keyboard submitted during this breaking changes cycle.... and it only _just_ made the cut-off!
6 6
@@ -11,9 +11,9 @@ QMK had it's 2000th keyboard submitted during this breaking changes cycle.... an
11 11
12From the whole QMK team, a major thankyou to the community for embracing QMK as your preferred keyboard firmware! 12From the whole QMK team, a major thankyou to the community for embracing QMK as your preferred keyboard firmware!
13 13
14## Notable Features :id=notable-features 14## Notable Features {#notable-features}
15 15
16### Expanded Pointing Device support ([#14343](https://github.com/qmk/qmk_firmware/pull/14343)) :id=expanded-pointing-device 16### Expanded Pointing Device support ([#14343](https://github.com/qmk/qmk_firmware/pull/14343)) {#expanded-pointing-device}
17 17
18Pointing device support has been reworked and reimplemented to allow for easier integration of new peripherals. 18Pointing device support has been reworked and reimplemented to allow for easier integration of new peripherals.
19 19
@@ -31,9 +31,9 @@ QMK now has core-supplied support for the following pointing device peripherals:
31| `POINTING_DEVICE_DRIVER = pimoroni_trackball` | Pimoroni Trackball | 31| `POINTING_DEVICE_DRIVER = pimoroni_trackball` | Pimoroni Trackball |
32| `POINTING_DEVICE_DRIVER = pmw3360` | PMW 3360 | 32| `POINTING_DEVICE_DRIVER = pmw3360` | PMW 3360 |
33 33
34See the new documentation for the [Pointing Device](../feature_pointing_device.md) feature for more information on specific configuration for each driver. 34See the new documentation for the [Pointing Device](../feature_pointing_device) feature for more information on specific configuration for each driver.
35 35
36### Dynamic Tapping Term ([#11036](https://github.com/qmk/qmk_firmware/pull/11036)) :id=dynamic-tapping-term 36### Dynamic Tapping Term ([#11036](https://github.com/qmk/qmk_firmware/pull/11036)) {#dynamic-tapping-term}
37 37
38For people who are starting out with tapping keys, or for people who think tapping keys don't "feel right", it's sometimes quite difficult to determine what duration of tapping term to use to make things seem natural. 38For people who are starting out with tapping keys, or for people who think tapping keys don't "feel right", it's sometimes quite difficult to determine what duration of tapping term to use to make things seem natural.
39 39
@@ -47,9 +47,9 @@ If you're in this stage of discovery, you can now add `DYNAMIC_TAPPING_TERM_ENAB
47 47
48Coupled with the use of `qmk console` or QMK Toolbox to show console output from your keyboard, you can tweak the tapping term dynamically in order to narrow down what "feels right" to you. Once you're happy, drop in the resulting number into your keymap's `config.h` and you're good to go! 48Coupled with the use of `qmk console` or QMK Toolbox to show console output from your keyboard, you can tweak the tapping term dynamically in order to narrow down what "feels right" to you. Once you're happy, drop in the resulting number into your keymap's `config.h` and you're good to go!
49 49
50### Macros in JSON keymaps ([#14374](https://github.com/qmk/qmk_firmware/pull/14374)) :id=macros-in-keymap-json 50### Macros in JSON keymaps ([#14374](https://github.com/qmk/qmk_firmware/pull/14374)) {#macros-in-keymap-json}
51 51
52You can now define up to 32 macros in your `keymap.json` file, as used by [QMK Configurator](newbs_building_firmware_configurator.md), and `qmk compile`. You can define these macros in a list under the `macros` keyword, like this: 52You can now define up to 32 macros in your `keymap.json` file, as used by [QMK Configurator](../newbs_building_firmware_configurator), and `qmk compile`. You can define these macros in a list under the `macros` keyword, like this:
53 53
54```json 54```json
55{ 55{
@@ -83,9 +83,9 @@ You can now define up to 32 macros in your `keymap.json` file, as used by [QMK C
83 83
84In due course, [QMK Configurator](https://config.qmk.fm/) will pick up support for defining these in its UI, but for now the json is the only way to define macros. 84In due course, [QMK Configurator](https://config.qmk.fm/) will pick up support for defining these in its UI, but for now the json is the only way to define macros.
85 85
86## Changes Requiring User Action :id=changes-requiring-user-action 86## Changes Requiring User Action {#changes-requiring-user-action}
87 87
88### Updated Keyboard Codebases :id=updated-keyboard-codebases 88### Updated Keyboard Codebases {#updated-keyboard-codebases}
89 89
90The following keyboards have had their source moved within QMK: 90The following keyboards have had their source moved within QMK:
91 91
@@ -104,21 +104,21 @@ The following keyboards have had their source moved within QMK:
104| signum/3_0/elitec | signum/3_0 | 104| signum/3_0/elitec | signum/3_0 |
105| tgr/jane | tgr/jane/v2 | 105| tgr/jane | tgr/jane/v2 |
106 106
107### Squeezing space out of AVR ([#15243](https://github.com/qmk/qmk_firmware/pull/15243)) :id=squeezing-space-from-avr 107### Squeezing space out of AVR ([#15243](https://github.com/qmk/qmk_firmware/pull/15243)) {#squeezing-space-from-avr}
108 108
109The AVR platform has been problematic for some time, in the sense that it is severely resource-constrained -- this makes life difficult for anyone attempting to add new functionality such as display panels to their keymap code. The illustrious Drashna has contributed some newer documentation on how to attempt to free up some space on AVR-based keyboards that are in short supply. 109The AVR platform has been problematic for some time, in the sense that it is severely resource-constrained -- this makes life difficult for anyone attempting to add new functionality such as display panels to their keymap code. The illustrious Drashna has contributed some newer documentation on how to attempt to free up some space on AVR-based keyboards that are in short supply.
110 110
111Of course, there are much fewer constraints with ARM chips... ;) 111Of course, there are much fewer constraints with ARM chips... ;)
112 112
113### Require explicit enabling of RGB Matrix modes ([#15018](https://github.com/qmk/qmk_firmware/pull/15018)) :id=explicit-rgb-modes 113### Require explicit enabling of RGB Matrix modes ([#15018](https://github.com/qmk/qmk_firmware/pull/15018)) {#explicit-rgb-modes}
114 114
115Related to the previous section -- RGB Matrix modes have now been made to be opt-in, rather than opt-out. As these animations are now opt-in, you may find that your keyboard no longer has all the RGB modes you're expecting -- you may need to configure and recompile your firmware and enable your animations of choice... with any luck they'll still fit in the space available. 115Related to the previous section -- RGB Matrix modes have now been made to be opt-in, rather than opt-out. As these animations are now opt-in, you may find that your keyboard no longer has all the RGB modes you're expecting -- you may need to configure and recompile your firmware and enable your animations of choice... with any luck they'll still fit in the space available.
116 116
117Most keyboards keep their original functionality, but over time the QMK maintainers have found that removal of animations ends up being the quickest way to free up space... and some keyboards have had animations such as reactive effects disabled by default in order to still fit within the flash space available. 117Most keyboards keep their original functionality, but over time the QMK maintainers have found that removal of animations ends up being the quickest way to free up space... and some keyboards have had animations such as reactive effects disabled by default in order to still fit within the flash space available.
118 118
119The full list of configurables to turn specific animations back on can be found at on the [RGB Matrix documentation](feature_rgb_matrix.md#rgb-matrix-effects) page. 119The full list of configurables to turn specific animations back on can be found at on the [RGB Matrix documentation](../feature_rgb_matrix#rgb-matrix-effects) page.
120 120
121### OLED task refactoring ([#14864](https://github.com/qmk/qmk_firmware/pull/14864)) :id=oled-task-refactor 121### OLED task refactoring ([#14864](https://github.com/qmk/qmk_firmware/pull/14864)) {#oled-task-refactor}
122 122
123OLED display code was traditionally difficult to override in keymaps as they did not follow the standard pattern of `bool *_kb()` deferring to `bool *_user()` functions, allowing signalling to the higher level that processing had already been done. 123OLED display code was traditionally difficult to override in keymaps as they did not follow the standard pattern of `bool *_kb()` deferring to `bool *_user()` functions, allowing signalling to the higher level that processing had already been done.
124 124
@@ -152,7 +152,7 @@ bool oled_task_kb(void) {
152} 152}
153``` 153```
154 154
155### Bootmagic Full Removal ([#15002](https://github.com/qmk/qmk_firmware/pull/15002)) :id=bootmagic-full-removal 155### Bootmagic Full Removal ([#15002](https://github.com/qmk/qmk_firmware/pull/15002)) {#bootmagic-full-removal}
156 156
157As noted during previous breaking changes cycles, QMK decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option. 157As noted during previous breaking changes cycles, QMK decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option.
158 158
@@ -170,13 +170,13 @@ This is the historical timeline for the behavior of `BOOTMAGIC_ENABLE`:
170- (done) From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail. 170- (done) From 2021 Aug 28, `BOOTMAGIC_ENABLE` must be either `yes`, `lite`, or `no` – setting `BOOTMAGIC_ENABLE = full` will cause compilation to fail.
171- (now) From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail. 171- (now) From 2021 Nov 27, `BOOTMAGIC_ENABLE` must be either `yes` or `no` – setting `BOOTMAGIC_ENABLE = lite` will cause compilation to fail.
172 172
173### Remove QWIIC_DRIVERS ([#14174](https://github.com/qmk/qmk_firmware/pull/14174)) :id=remove-qwiic 173### Remove QWIIC_DRIVERS ([#14174](https://github.com/qmk/qmk_firmware/pull/14174)) {#remove-qwiic}
174 174
175Due to minimal QWIIC adoption and other options for similar functionality, the QWIIC drivers were removed from QMK. Existing OLED usages have been migrated across to the normal QMK OLED driver instead. 175Due to minimal QWIIC adoption and other options for similar functionality, the QWIIC drivers were removed from QMK. Existing OLED usages have been migrated across to the normal QMK OLED driver instead.
176 176
177## Notable core changes :id=notable-core 177## Notable core changes {#notable-core}
178 178
179### New MCU Support :id=new-mcu-support 179### New MCU Support {#new-mcu-support}
180 180
181QMK firmware picked up support for a handful of new MCU families, potentially making it a bit easier to source components. 181QMK firmware picked up support for a handful of new MCU families, potentially making it a bit easier to source components.
182 182
@@ -187,7 +187,7 @@ QMK firmware is now no longer limited to AVR and ARM - it also picked up support
187* Westberrytech pr ([#14422](https://github.com/qmk/qmk_firmware/pull/14422)) 187* Westberrytech pr ([#14422](https://github.com/qmk/qmk_firmware/pull/14422))
188* Initial pass of F405 support ([#14584](https://github.com/qmk/qmk_firmware/pull/14584)) 188* Initial pass of F405 support ([#14584](https://github.com/qmk/qmk_firmware/pull/14584))
189 189
190### EEPROM Changes :id=eeprom-changes 190### EEPROM Changes {#eeprom-changes}
191 191
192There were a few EEPROM-related changes that landed during this breaking changes cycle, most prominently the long-awaited ability for the Drop boards to gain persistent storage. Any users of the Drop CTRL or Drop ALT should update QMK Toolbox as well -- coupled with a QMK firmware update settings should now be saved. 192There were a few EEPROM-related changes that landed during this breaking changes cycle, most prominently the long-awaited ability for the Drop boards to gain persistent storage. Any users of the Drop CTRL or Drop ALT should update QMK Toolbox as well -- coupled with a QMK firmware update settings should now be saved.
193 193
@@ -197,7 +197,7 @@ There were a few EEPROM-related changes that landed during this breaking changes
197* Further tidy up of STM32 eeprom emulation ([#14591](https://github.com/qmk/qmk_firmware/pull/14591)) 197* Further tidy up of STM32 eeprom emulation ([#14591](https://github.com/qmk/qmk_firmware/pull/14591))
198* Enable eeprom with F401xE ld ([#14752](https://github.com/qmk/qmk_firmware/pull/14752)) 198* Enable eeprom with F401xE ld ([#14752](https://github.com/qmk/qmk_firmware/pull/14752))
199 199
200### Compilation Database :id=compile-commands 200### Compilation Database {#compile-commands}
201 201
202A clang-compatible compilation database generator has been added as an option in order to help development environments such as Visual Studio Code. 202A clang-compatible compilation database generator has been added as an option in order to help development environments such as Visual Studio Code.
203 203
@@ -208,7 +208,7 @@ Do note that switching keyboards will require re-generation of this file.
208* New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) ([#14370](https://github.com/qmk/qmk_firmware/pull/14370)) 208* New CLI subcommand to create clang-compatible compilation database (`compile_commands.json`) ([#14370](https://github.com/qmk/qmk_firmware/pull/14370))
209* compiledb: query include paths from gcc directly. ([#14462](https://github.com/qmk/qmk_firmware/pull/14462)) 209* compiledb: query include paths from gcc directly. ([#14462](https://github.com/qmk/qmk_firmware/pull/14462))
210 210
211### Codebase restructure and cleanup :id=codebase-restructure 211### Codebase restructure and cleanup {#codebase-restructure}
212 212
213QMK continues on its restructuring journey, in order to make it easier to integrate newer features and add support for new hardware. This quarter's batch of changes include: 213QMK continues on its restructuring journey, in order to make it easier to integrate newer features and add support for new hardware. This quarter's batch of changes include:
214 214
diff --git a/docs/ChangeLog/20220226.md b/docs/ChangeLog/20220226.md
index a469612fe8..f0cbbc0603 100644
--- a/docs/ChangeLog/20220226.md
+++ b/docs/ChangeLog/20220226.md
@@ -1,6 +1,6 @@
1# QMK Breaking Changes - 2022 February 26 Changelog 1# QMK Breaking Changes - 2022 February 26 Changelog
2 2
3## Notable Features :id=notable-features 3## Notable Features {#notable-features}
4 4
5### Default USB Polling rate now 1kHz ([#15352](https://github.com/qmk/qmk_firmware/pull/15352)) 5### Default USB Polling rate now 1kHz ([#15352](https://github.com/qmk/qmk_firmware/pull/15352))
6 6
@@ -12,13 +12,13 @@ Something something *Lets go gamers!*
12 12
13Pointing devices can now be shared across a split keyboard with support for a single pointing device or a pointing device on each side. 13Pointing devices can now be shared across a split keyboard with support for a single pointing device or a pointing device on each side.
14 14
15See the [Pointing Device](feature_pointing_device.md) documentation for further configuration options. 15See the [Pointing Device](../feature_pointing_device) documentation for further configuration options.
16 16
17## Changes Requiring User Action :id=changes-requiring-user-action 17## Changes Requiring User Action {#changes-requiring-user-action}
18 18
19### Legacy macro and action_function system removed ([#16025](https://github.com/qmk/qmk_firmware/pull/16025)) 19### Legacy macro and action_function system removed ([#16025](https://github.com/qmk/qmk_firmware/pull/16025))
20 20
21The long time deprecated `MACRO()` and `action_get_macro` methods have been removed. Where possible, existing usages have been migrated over to core [Macros](feature_macros.md). 21The long time deprecated `MACRO()` and `action_get_macro` methods have been removed. Where possible, existing usages have been migrated over to core [Macros](../feature_macros).
22 22
23### Create a build error if no bootloader is specified ([#16181](https://github.com/qmk/qmk_firmware/pull/16181)) 23### Create a build error if no bootloader is specified ([#16181](https://github.com/qmk/qmk_firmware/pull/16181))
24 24
@@ -31,7 +31,7 @@ Bootloader configuration is no longer assumed. Keyboards must now set either:
31 31
32In preparation of future bluetooth work, the `AdafruitBLE` integration has been renamed to allow potential for any other Adafruit BLE products. 32In preparation of future bluetooth work, the `AdafruitBLE` integration has been renamed to allow potential for any other Adafruit BLE products.
33 33
34### Updated Keyboard Codebases :id=updated-keyboard-codebases 34### Updated Keyboard Codebases {#updated-keyboard-codebases}
35 35
36The following keyboards have had their source moved within QMK: 36The following keyboards have had their source moved within QMK:
37 37
@@ -241,9 +241,9 @@ The following keyboards have had their source moved within QMK:
241| zinc/rev1 | 25keys/zinc/rev1 | 241| zinc/rev1 | 25keys/zinc/rev1 |
242| zinc/reva | 25keys/zinc/reva | 242| zinc/reva | 25keys/zinc/reva |
243 243
244## Notable core changes :id=notable-core 244## Notable core changes {#notable-core}
245 245
246### New MCU Support :id=new-mcu-support 246### New MCU Support {#new-mcu-support}
247 247
248Building on previous cycles, QMK firmware picked up support for a couple extra MCU variants: 248Building on previous cycles, QMK firmware picked up support for a couple extra MCU variants:
249 249
diff --git a/docs/ChangeLog/20220528.md b/docs/ChangeLog/20220528.md
index 1265c81206..31347c9c00 100644
--- a/docs/ChangeLog/20220528.md
+++ b/docs/ChangeLog/20220528.md
@@ -1,16 +1,16 @@
1# QMK Breaking Changes - 2022 May 28 Changelog 1# QMK Breaking Changes - 2022 May 28 Changelog
2 2
3## Notable Features :id=notable-features 3## Notable Features {#notable-features}
4 4
5### Caps Word ([#16588](https://github.com/qmk/qmk_firmware/pull/16588)) :id=caps-word 5### Caps Word ([#16588](https://github.com/qmk/qmk_firmware/pull/16588)) {#caps-word}
6 6
7This is a new feature that allows for capslock-like functionality that turns itself off at the end of the word. 7This is a new feature that allows for capslock-like functionality that turns itself off at the end of the word.
8 8
9For instance, if you wish to type "QMK" without holding shift the entire time, you can either tap both left and right shift, or double-tap shift, to turn on _Caps Word_ -- then type `qmk` (lowercase) without holding shift. Once you hit any key other than `a`--`z`, `0`--`9`, `-`, `_`, delete, or backspace, this will go back to normal typing! 9For instance, if you wish to type "QMK" without holding shift the entire time, you can either tap both left and right shift, or double-tap shift, to turn on _Caps Word_ -- then type `qmk` (lowercase) without holding shift. Once you hit any key other than `a`--`z`, `0`--`9`, `-`, `_`, delete, or backspace, this will go back to normal typing!
10 10
11There are other activation mechanisms as well as configurable options like timeout and the like -- see the [Caps Word documentation](feature_caps_word.md) for more information. 11There are other activation mechanisms as well as configurable options like timeout and the like -- see the [Caps Word documentation](../feature_caps_word) for more information.
12 12
13### Quantum Painter ([#10174](https://github.com/qmk/qmk_firmware/pull/10174)) :id=quantum-painter 13### Quantum Painter ([#10174](https://github.com/qmk/qmk_firmware/pull/10174)) {#quantum-painter}
14 14
15QMK has had support for small OLED displays for some time now, but hasn't really gained too much ability to draw to panels other than the SSD1306 or SH1106 panels. 15QMK has had support for small OLED displays for some time now, but hasn't really gained too much ability to draw to panels other than the SSD1306 or SH1106 panels.
16 16
@@ -18,27 +18,31 @@ Quantum Painter is a new drawing subsystem available to suitable ARM and RISC-V
18 18
19The QMK CLI has new commands added to be able to generate images and fonts for Quantum Painter to digest -- it's even capable of converting animated gifs for display on screen. 19The QMK CLI has new commands added to be able to generate images and fonts for Quantum Painter to digest -- it's even capable of converting animated gifs for display on screen.
20 20
21See the [Quantum Painter documentation](quantum_painter.md) for more information on how to set up the displays as well as how to convert images and fonts. 21See the [Quantum Painter documentation](../quantum_painter) for more information on how to set up the displays as well as how to convert images and fonts.
22 22
23!> Quantum Painter is not supported on AVR due to complexity and size constraints. Boards based on AVR such as ProMicro or Elite-C builds will not be able to leverage Quantum Painter. 23::: warning
24Quantum Painter is not supported on AVR due to complexity and size constraints. Boards based on AVR such as ProMicro or Elite-C builds will not be able to leverage Quantum Painter.
25:::
24 26
25### Encoder Mapping ([#13286](https://github.com/qmk/qmk_firmware/pull/13286)) :id=encoder-mapping 27### Encoder Mapping ([#13286](https://github.com/qmk/qmk_firmware/pull/13286)) {#encoder-mapping}
26 28
27One of the long-standing complaints with Encoders is that there has been no easy way to configure them in user keymaps. [#13286](https://github.com/qmk/qmk_firmware/pull/13286) added support for [Encoder Mapping](feature_encoders.md#encoder-map), which allows users to define encoder functionality in a similar way to their normal keymap. 29One of the long-standing complaints with Encoders is that there has been no easy way to configure them in user keymaps. [#13286](https://github.com/qmk/qmk_firmware/pull/13286) added support for [Encoder Mapping](../feature_encoders#encoder-map), which allows users to define encoder functionality in a similar way to their normal keymap.
28 30
29!> This is not yet supported by QMK Configurator. It is also unlikely to ever be supported by VIA. 31::: warning
32This is not yet supported by QMK Configurator. It is also unlikely to ever be supported by VIA.
33:::
30 34
31## Changes Requiring User Action :id=changes-requiring-user-action 35## Changes Requiring User Action {#changes-requiring-user-action}
32 36
33### `RESET` => `QK_BOOT` ([#17037](https://github.com/qmk/qmk_firmware/pull/17037)) :id=reset-2-qk_boot 37### `RESET` => `QK_BOOT` ([#17037](https://github.com/qmk/qmk_firmware/pull/17037)) {#reset-2-qk_boot}
34 38
35QMK is always in the process of picking up support for new hardware platforms. One of the side-effects for future integrations has shown that QMK's usage of `RESET` as a keycode is causing naming collisions. As a result, [#17037](https://github.com/qmk/qmk_firmware/pull/17037) changed usages of `RESET` to the new keycode `QK_BOOT` in the majority of default-like keymaps. At this stage the old keycode is still usable but will likely be removed in the next breaking changes cycle. Users with keymaps containing `RESET` should also move to `QK_BOOT`. 39QMK is always in the process of picking up support for new hardware platforms. One of the side-effects for future integrations has shown that QMK's usage of `RESET` as a keycode is causing naming collisions. As a result, [#17037](https://github.com/qmk/qmk_firmware/pull/17037) changed usages of `RESET` to the new keycode `QK_BOOT` in the majority of default-like keymaps. At this stage the old keycode is still usable but will likely be removed in the next breaking changes cycle. Users with keymaps containing `RESET` should also move to `QK_BOOT`.
36 40
37### Sendstring keycode overhaul ([#16941](https://github.com/qmk/qmk_firmware/pull/16941)) :id=sendstring-keycodes 41### Sendstring keycode overhaul ([#16941](https://github.com/qmk/qmk_firmware/pull/16941)) {#sendstring-keycodes}
38 42
39Some keycodes used with `SEND_STRING` and its relatives have been deprecated and may have their old keycode usages removed at a later date. The list of [deprecated keycodes](https://github.com/qmk/qmk_firmware/blob/ebd402788346aa6e88bde1486b2a835684d40d39/quantum/send_string_keycodes.h#L456-L505) should be consulted to determine if you're using one of the older names (the first identifier after `#define`) -- you should swap to the newer variant (the second identifier on the same line). 43Some keycodes used with `SEND_STRING` and its relatives have been deprecated and may have their old keycode usages removed at a later date. The list of [deprecated keycodes](https://github.com/qmk/qmk_firmware/blob/ebd402788346aa6e88bde1486b2a835684d40d39/quantum/send_string_keycodes.h#L456-L505) should be consulted to determine if you're using one of the older names (the first identifier after `#define`) -- you should swap to the newer variant (the second identifier on the same line).
40 44
41### Pillow Installation ([#17133](https://github.com/qmk/qmk_firmware/pull/17133)) :id=pillow-install 45### Pillow Installation ([#17133](https://github.com/qmk/qmk_firmware/pull/17133)) {#pillow-install}
42 46
43The merge of Quantum Painter added some new dependencies in the QMK CLI, most notably _Pillow_, which requires some installation in order for the CLI to function. If you've got an existing installation, you'll need to run some commands in order to get things working: 47The merge of Quantum Painter added some new dependencies in the QMK CLI, most notably _Pillow_, which requires some installation in order for the CLI to function. If you've got an existing installation, you'll need to run some commands in order to get things working:
44 48
@@ -62,7 +66,7 @@ On Linux or WSL:
62python3 -m pip install --user --upgrade qmk 66python3 -m pip install --user --upgrade qmk
63``` 67```
64 68
65### Updated Keyboard Codebases :id=updated-keyboard-codebases 69### Updated Keyboard Codebases {#updated-keyboard-codebases}
66 70
67The following keyboards have had their source moved within QMK: 71The following keyboards have had their source moved within QMK:
68 72
@@ -97,7 +101,7 @@ The following keyboards have had their source moved within QMK:
97 101
98--- 102---
99 103
100## Full changelist :id=full-changelist 104## Full changelist {#full-changelist}
101 105
102Core: 106Core:
103* Quantum Painter ([#10174](https://github.com/qmk/qmk_firmware/pull/10174)) 107* Quantum Painter ([#10174](https://github.com/qmk/qmk_firmware/pull/10174))
diff --git a/docs/ChangeLog/20220827.md b/docs/ChangeLog/20220827.md
index b672b57cb8..d58db91272 100644
--- a/docs/ChangeLog/20220827.md
+++ b/docs/ChangeLog/20220827.md
@@ -1,28 +1,28 @@
1# QMK Breaking Changes - 2022 August 27 Changelog 1# QMK Breaking Changes - 2022 August 27 Changelog
2 2
3## Notable Features :id=notable-features 3## Notable Features {#notable-features}
4 4
5### Add Raspberry Pi RP2040 support ([#14877](https://github.com/qmk/qmk_firmware/pull/14877), [#17514](https://github.com/qmk/qmk_firmware/pull/17514), [#17516](https://github.com/qmk/qmk_firmware/pull/17516), [#17519](https://github.com/qmk/qmk_firmware/pull/17519), [#17612](https://github.com/qmk/qmk_firmware/pull/17612), [#17512](https://github.com/qmk/qmk_firmware/pull/17512), [#17557](https://github.com/qmk/qmk_firmware/pull/17557), [#17817](https://github.com/qmk/qmk_firmware/pull/17817), [#17839](https://github.com/qmk/qmk_firmware/pull/17839), [#18100](https://github.com/qmk/qmk_firmware/pull/18100)) :id=rp2040-support 5### Add Raspberry Pi RP2040 support ([#14877](https://github.com/qmk/qmk_firmware/pull/14877), [#17514](https://github.com/qmk/qmk_firmware/pull/17514), [#17516](https://github.com/qmk/qmk_firmware/pull/17516), [#17519](https://github.com/qmk/qmk_firmware/pull/17519), [#17612](https://github.com/qmk/qmk_firmware/pull/17612), [#17512](https://github.com/qmk/qmk_firmware/pull/17512), [#17557](https://github.com/qmk/qmk_firmware/pull/17557), [#17817](https://github.com/qmk/qmk_firmware/pull/17817), [#17839](https://github.com/qmk/qmk_firmware/pull/17839), [#18100](https://github.com/qmk/qmk_firmware/pull/18100)) {#rp2040-support}
6 6
7QMK _finally_ picked up support for RP2040-based boards, such as the Raspberry Pi Pico, the Sparkfun Pro Micro RP2040, and the Adafruit KB2040. One of QMK's newest collaborators, _@KarlK90_, effectively did `/micdrop` with RP2040, with a massive set of changes to both QMK and the repository QMK uses for the base platform support, ChibiOS[-Contrib]. There has been a flurry of development this breaking changes cycle related to RP2040 from a large number of contributors -- so much so that almost all standard QMK hardware subsystems are supported. 7QMK _finally_ picked up support for RP2040-based boards, such as the Raspberry Pi Pico, the Sparkfun Pro Micro RP2040, and the Adafruit KB2040. One of QMK's newest collaborators, _@KarlK90_, effectively did `/micdrop` with RP2040, with a massive set of changes to both QMK and the repository QMK uses for the base platform support, ChibiOS[-Contrib]. There has been a flurry of development this breaking changes cycle related to RP2040 from a large number of contributors -- so much so that almost all standard QMK hardware subsystems are supported.
8 8
9Check the [RP2040 platform development page](platformdev_rp2040.md) for all supported peripherals and other hardware implementation details. 9Check the [RP2040 platform development page](../platformdev_rp2040) for all supported peripherals and other hardware implementation details.
10 10
11### Allow `qmk flash` to use prebuilt firmware binaries ([#16584](https://github.com/qmk/qmk_firmware/pull/16584)) :id=cli-flash-binaries 11### Allow `qmk flash` to use prebuilt firmware binaries ([#16584](https://github.com/qmk/qmk_firmware/pull/16584)) {#cli-flash-binaries}
12 12
13A long-requested capability of the QMK CLI has been the ability to flash binaries directly, without needing to build a firmware. QMK provides prebuilt `develop`-based default firmwares on our [CI page](https://qmk.tzarc.io/) -- normally people would need [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases/latest) to flash them. This new functionality written by _@Erovia_ allows `qmk flash` to be provided the prebuilt file instead, simplifying the workflow for people who haven't got Toolbox available. 13A long-requested capability of the QMK CLI has been the ability to flash binaries directly, without needing to build a firmware. QMK provides prebuilt `develop`-based default firmwares on our [CI page](https://qmk.tzarc.io/) -- normally people would need [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases/latest) to flash them. This new functionality written by _@Erovia_ allows `qmk flash` to be provided the prebuilt file instead, simplifying the workflow for people who haven't got Toolbox available.
14 14
15## Changes Requiring User Action :id=changes-requiring-user-action 15## Changes Requiring User Action {#changes-requiring-user-action}
16 16
17### Default layers dropped from 32 to 16 ([#15286](https://github.com/qmk/qmk_firmware/pull/15286)) 17### Default layers dropped from 32 to 16 ([#15286](https://github.com/qmk/qmk_firmware/pull/15286))
18 18
19QMK allows for controlling the maximum number of layers it supports through `LAYER_STATE_(8|16|32)BIT`. Each definition allows for the same number of maximum layers -- `LAYER_STATE_8BIT` => 8 layers. There is also a corresponding firmware size decrease that goes along with smaller numbers -- given the vast majority of users don't use more than 16 layers the default has been swapped to 16. AVR users who were not previously specifying their max layer count may see some space freed up as a result. 19QMK allows for controlling the maximum number of layers it supports through `LAYER_STATE_(8|16|32)BIT`. Each definition allows for the same number of maximum layers -- `LAYER_STATE_8BIT` => 8 layers. There is also a corresponding firmware size decrease that goes along with smaller numbers -- given the vast majority of users don't use more than 16 layers the default has been swapped to 16. AVR users who were not previously specifying their max layer count may see some space freed up as a result.
20 20
21### `RESET` => `QK_BOOT` ([#17940](https://github.com/qmk/qmk_firmware/pull/17940)) :id=reset-2-qk_boot 21### `RESET` => `QK_BOOT` ([#17940](https://github.com/qmk/qmk_firmware/pull/17940)) {#reset-2-qk_boot}
22 22
23Following the last breaking changes cycle, QMK has been migrating usages of `RESET` to `QK_BOOT` due to naming collisions with our upstream board support packages. [#17940](https://github.com/qmk/qmk_firmware/pull/17940) converts user keymaps across to use the new keycode name. `RESET` should also move to `QK_BOOT`. 23Following the last breaking changes cycle, QMK has been migrating usages of `RESET` to `QK_BOOT` due to naming collisions with our upstream board support packages. [#17940](https://github.com/qmk/qmk_firmware/pull/17940) converts user keymaps across to use the new keycode name. `RESET` should also move to `QK_BOOT`.
24 24
25### Updated Keyboard Codebases :id=updated-keyboard-codebases 25### Updated Keyboard Codebases {#updated-keyboard-codebases}
26 26
27The following keyboards have had their source moved within QMK: 27The following keyboards have had their source moved within QMK:
28 28
@@ -33,7 +33,7 @@ The following keyboards have had their source moved within QMK:
33| idobao/id80/v1/ansi | idobao/id80/v2/ansi | 33| idobao/id80/v1/ansi | idobao/id80/v2/ansi |
34| idobao/id80/v1/iso | idobao/id80/v2/iso | 34| idobao/id80/v1/iso | idobao/id80/v2/iso |
35 35
36### Data-driven USB IDs Refactoring ([#18152](https://github.com/qmk/qmk_firmware/pull/18152)) :id=usb-ids-Refactoring 36### Data-driven USB IDs Refactoring ([#18152](https://github.com/qmk/qmk_firmware/pull/18152)) {#usb-ids-Refactoring}
37 37
38QMK has decided to deprecate the specification of USB IDs inside `config.h` in favour of `info.json`, eventually leaving data-driven as the only method to specify USB information. 38QMK has decided to deprecate the specification of USB IDs inside `config.h` in favour of `info.json`, eventually leaving data-driven as the only method to specify USB information.
39 39
@@ -67,25 +67,25 @@ Replaced by `info.json`:
67- From 2022 Aug 27, specifying USB information in `config.h` will produce warnings during build but will still function as previously. 67- From 2022 Aug 27, specifying USB information in `config.h` will produce warnings during build but will still function as previously.
68- From 2022 Nov 26, specifying USB information in `config.h` will cause compilation to fail. 68- From 2022 Nov 26, specifying USB information in `config.h` will cause compilation to fail.
69 69
70## Notable core changes :id=notable-core 70## Notable core changes {#notable-core}
71 71
72### Board converters ([#17514](https://github.com/qmk/qmk_firmware/pull/17514), [#17603](https://github.com/qmk/qmk_firmware/pull/17603), [#17711](https://github.com/qmk/qmk_firmware/pull/17711), [#17827](https://github.com/qmk/qmk_firmware/pull/17827), [#17593](https://github.com/qmk/qmk_firmware/pull/17593), [#17652](https://github.com/qmk/qmk_firmware/pull/17652), [#17595](https://github.com/qmk/qmk_firmware/pull/17595)) :id=board-converters 72### Board converters ([#17514](https://github.com/qmk/qmk_firmware/pull/17514), [#17603](https://github.com/qmk/qmk_firmware/pull/17603), [#17711](https://github.com/qmk/qmk_firmware/pull/17711), [#17827](https://github.com/qmk/qmk_firmware/pull/17827), [#17593](https://github.com/qmk/qmk_firmware/pull/17593), [#17652](https://github.com/qmk/qmk_firmware/pull/17652), [#17595](https://github.com/qmk/qmk_firmware/pull/17595)) {#board-converters}
73 73
74Historically QMK had a `CONVERT_TO_PROTON_C` directive for `rules.mk` to allow people to replace an AVR-based Pro Micro with a QMK Proton C. Global parts shortages have prompted people to create their own pin-compatible boards -- QMK has made this conversion generic and now allows for drop-in replacements for a lot more boards. see the [Converters Feature](feature_converters.md) documentation for the full list of supported replacement boards -- in this breaking changes cycle we've gone from 1 to 7. 74Historically QMK had a `CONVERT_TO_PROTON_C` directive for `rules.mk` to allow people to replace an AVR-based Pro Micro with a QMK Proton C. Global parts shortages have prompted people to create their own pin-compatible boards -- QMK has made this conversion generic and now allows for drop-in replacements for a lot more boards. see the [Converters Feature](../feature_converters) documentation for the full list of supported replacement boards -- in this breaking changes cycle we've gone from 1 to 7.
75 75
76### Add cli command to import keyboard|keymap|kbfirmware ([#16668](https://github.com/qmk/qmk_firmware/pull/16668)) :id=cli-import 76### Add cli command to import keyboard|keymap|kbfirmware ([#16668](https://github.com/qmk/qmk_firmware/pull/16668)) {#cli-import}
77 77
78To help with importing keyboards and keymaps from other sources, _@zvecr_ added [#16668](https://github.com/qmk/qmk_firmware/pull/16668) which adds a new set of commands to the CLI to automatically import keyboards (`qmk import-keyboard -h`), keymaps (`qmk import-keymap -h`), and kbfirmware definitions (`qmk import-kbfirmware -h`) into QMK. 78To help with importing keyboards and keymaps from other sources, _@zvecr_ added [#16668](https://github.com/qmk/qmk_firmware/pull/16668) which adds a new set of commands to the CLI to automatically import keyboards (`qmk import-keyboard -h`), keymaps (`qmk import-keymap -h`), and kbfirmware definitions (`qmk import-kbfirmware -h`) into QMK.
79 79
80The now-EOL kbfirmware allowed people who aren't set up with QMK the ability to create keyboard firmwares without requiring a full installation of QMK. Unfortunately, it targets a 7-year-old version of QMK -- adding frustration for users who want the newest features, as well as for QMK maintainers who have to spend time explaining why QMK can't just accept a drive-by code drop from kbfirmware. With any luck, this new command helps both camps! 80The now-EOL kbfirmware allowed people who aren't set up with QMK the ability to create keyboard firmwares without requiring a full installation of QMK. Unfortunately, it targets a 7-year-old version of QMK -- adding frustration for users who want the newest features, as well as for QMK maintainers who have to spend time explaining why QMK can't just accept a drive-by code drop from kbfirmware. With any luck, this new command helps both camps!
81 81
82### Generic wear-leveling for EEPROM emulation ([#16996](https://github.com/qmk/qmk_firmware/pull/16996), [#17376](https://github.com/qmk/qmk_firmware/pull/17376), [#18102](https://github.com/qmk/qmk_firmware/pull/18102)) :id=wear-leveling 82### Generic wear-leveling for EEPROM emulation ([#16996](https://github.com/qmk/qmk_firmware/pull/16996), [#17376](https://github.com/qmk/qmk_firmware/pull/17376), [#18102](https://github.com/qmk/qmk_firmware/pull/18102)) {#wear-leveling}
83 83
84QMK has had the ability to write to internal MCU flash in order to emulate EEPROM for some time now, but it was only limited to a small number of MCUs. The base HAL used by QMK for a large number of ARM devices provides a "proper" embedded MCU flash driver, so _@tzarc_ decoupled the wear-leveling algorithm from the old flash writing code, improved it, wrote some tests, and enabled its use for a much larger number of other devices... including RP2040's XIP flash, and external SPI NOR Flash. 84QMK has had the ability to write to internal MCU flash in order to emulate EEPROM for some time now, but it was only limited to a small number of MCUs. The base HAL used by QMK for a large number of ARM devices provides a "proper" embedded MCU flash driver, so _@tzarc_ decoupled the wear-leveling algorithm from the old flash writing code, improved it, wrote some tests, and enabled its use for a much larger number of other devices... including RP2040's XIP flash, and external SPI NOR Flash.
85 85
86See the [EEPROM Driver](eeprom_driver.md) documentation for more information. 86See the [EEPROM Driver](../eeprom_driver) documentation for more information.
87 87
88### Pointing Device Improvements ([#16371](https://github.com/qmk/qmk_firmware/pull/16371), [#17111](https://github.com/qmk/qmk_firmware/pull/17111), [#17176](https://github.com/qmk/qmk_firmware/pull/17176), [#17482](https://github.com/qmk/qmk_firmware/pull/17482), [#17776](https://github.com/qmk/qmk_firmware/pull/17776), [#17613](https://github.com/qmk/qmk_firmware/pull/17613)) :id=pointing-device-improvements 88### Pointing Device Improvements ([#16371](https://github.com/qmk/qmk_firmware/pull/16371), [#17111](https://github.com/qmk/qmk_firmware/pull/17111), [#17176](https://github.com/qmk/qmk_firmware/pull/17176), [#17482](https://github.com/qmk/qmk_firmware/pull/17482), [#17776](https://github.com/qmk/qmk_firmware/pull/17776), [#17613](https://github.com/qmk/qmk_firmware/pull/17613)) {#pointing-device-improvements}
89 89
90Ever since Pointing Device Driver support and Split Pointing Device support were added by _@drashna_ and _@daskygit_, there has been increased interest in the development of the pointing device subsystem and its associated code. 90Ever since Pointing Device Driver support and Split Pointing Device support were added by _@drashna_ and _@daskygit_, there has been increased interest in the development of the pointing device subsystem and its associated code.
91 91
@@ -102,7 +102,7 @@ Other related changes:
102 102
103--- 103---
104 104
105## Full changelist :id=full-changelist 105## Full changelist {#full-changelist}
106 106
107Core: 107Core:
108* Tentative Teensy 3.5 support ([#14420](https://github.com/qmk/qmk_firmware/pull/14420)) 108* Tentative Teensy 3.5 support ([#14420](https://github.com/qmk/qmk_firmware/pull/14420))
diff --git a/docs/ChangeLog/20221126.md b/docs/ChangeLog/20221126.md
index 82aa4a499e..25cf1d592d 100644
--- a/docs/ChangeLog/20221126.md
+++ b/docs/ChangeLog/20221126.md
@@ -1,14 +1,14 @@
1# QMK Breaking Changes - 2022 November 26 Changelog 1# QMK Breaking Changes - 2022 November 26 Changelog
2 2
3## Notable Features :id=notable-features 3## Notable Features {#notable-features}
4 4
5### Autocorrect ([#15699](https://github.com/qmk/qmk_firmware/pull/15699)) :id=autocorrect 5### Autocorrect ([#15699](https://github.com/qmk/qmk_firmware/pull/15699)) {#autocorrect}
6 6
7_@getreuer_ in their infinite wisdom decided that autocorrect was a feature needed by QMK. As is customary, _@drashna_ adapted it to core and got it into a state that everyone else can use it. See [Feature: Autocorrect](feature_autocorrect.md) for more ifnormation (grin). 7_@getreuer_ in their infinite wisdom decided that autocorrect was a feature needed by QMK. As is customary, _@drashna_ adapted it to core and got it into a state that everyone else can use it. See [Feature: Autocorrect](../feature_autocorrect) for more ifnormation (grin).
8 8
9## Changes Requiring User Action :id=changes-requiring-user-action 9## Changes Requiring User Action {#changes-requiring-user-action}
10 10
11### Updated Keyboard Codebases :id=updated-keyboard-codebases 11### Updated Keyboard Codebases {#updated-keyboard-codebases}
12 12
13The following keyboards have had their source moved within QMK: 13The following keyboards have had their source moved within QMK:
14 14
@@ -23,17 +23,19 @@ The following keyboards have had their source moved within QMK:
23| handwired/hillside/52 | hillside/52 | 23| handwired/hillside/52 | hillside/52 |
24| maple_computing/christmas_tree/V2017 | maple_computing/christmas_tree/v2017 | 24| maple_computing/christmas_tree/V2017 | maple_computing/christmas_tree/v2017 |
25 25
26### Keycodes refactoring :id=keycodes-overhaul-user-action 26### Keycodes refactoring {#keycodes-overhaul-user-action}
27 27
28QMK's keycodes got a very significant overhaul this breaking changes cycle, with the bulk of the work done by _@zvecr_ and _@fauxpark_ -- renaming, reordering, removing has been their focus in this area. In an attempt to standardise interoperation with host applications, keycode values now have strong versioning so that any connected application has confidence that the keys it thinks exist on the board actually match up with what's compiled in. These strongly-versioned keycode definitions are now published online and will not change, so tools that remap keycodes have a reference to work with. In future versions of QMK, any new or changed keycodes will result in a new version specification. See [API docs](api_docs.md#qmk-constants) for more information on the published versions if you're writing a tool to manage keycodes. 28QMK's keycodes got a very significant overhaul this breaking changes cycle, with the bulk of the work done by _@zvecr_ and _@fauxpark_ -- renaming, reordering, removing has been their focus in this area. In an attempt to standardise interoperation with host applications, keycode values now have strong versioning so that any connected application has confidence that the keys it thinks exist on the board actually match up with what's compiled in. These strongly-versioned keycode definitions are now published online and will not change, so tools that remap keycodes have a reference to work with. In future versions of QMK, any new or changed keycodes will result in a new version specification. See [API docs](../api_docs#qmk-constants) for more information on the published versions if you're writing a tool to manage keycodes.
29 29
30In most cases user keymaps in the repository have already been updated to reflect the new naming scheme. In some cases user keymaps outside the repository may strike a missing keycode with the old name -- it's highly likely that the name had already been deprecated for some time, and should have been updated previously. 30In most cases user keymaps in the repository have already been updated to reflect the new naming scheme. In some cases user keymaps outside the repository may strike a missing keycode with the old name -- it's highly likely that the name had already been deprecated for some time, and should have been updated previously.
31 31
32See below for the full list of changesets. 32See below for the full list of changesets.
33 33
34!> Keycode aliases have been put in place in most cases to cater for "old names" being mapped to "new names" -- the documentation already reflects all the new naming of keys. 34::: warning
35Keycode aliases have been put in place in most cases to cater for "old names" being mapped to "new names" -- the documentation already reflects all the new naming of keys.
36:::
35 37
36### Configuration Item Refactoring :id=config-refactoring 38### Configuration Item Refactoring {#config-refactoring}
37 39
38A number of configuration items have been renamed for consistency. 40A number of configuration items have been renamed for consistency.
39 41
@@ -66,7 +68,7 @@ Joystick configuration:
66| JOYSTICK_AXES_COUNT | JOYSTICK_AXIS_COUNT | 68| JOYSTICK_AXES_COUNT | JOYSTICK_AXIS_COUNT |
67| JOYSTICK_AXES_RESOLUTION | JOYSTICK_AXIS_RESOLUTION | 69| JOYSTICK_AXES_RESOLUTION | JOYSTICK_AXIS_RESOLUTION |
68 70
69### Data-driven USB IDs Refactoring ([#18152](https://github.com/qmk/qmk_firmware/pull/18152)) :id=usb-ids-Refactoring 71### Data-driven USB IDs Refactoring ([#18152](https://github.com/qmk/qmk_firmware/pull/18152)) {#usb-ids-Refactoring}
70 72
71QMK has decided to deprecate the specification of USB IDs inside `config.h` in favour of `info.json`, leaving data-driven as the only method to specify USB information. As per the deprecation schedule put forward last breaking changes cycle, USB information must be specified in `info.json` instead. 73QMK has decided to deprecate the specification of USB IDs inside `config.h` in favour of `info.json`, leaving data-driven as the only method to specify USB information. As per the deprecation schedule put forward last breaking changes cycle, USB information must be specified in `info.json` instead.
72 74
@@ -92,7 +94,7 @@ Replaced by `info.json`:
92} 94}
93``` 95```
94 96
95### LED Indicator callback refactoring ([#14864](https://github.com/qmk/qmk_firmware/pull/18450)) :id=led-callback-refactor 97### LED Indicator callback refactoring ([#14864](https://github.com/qmk/qmk_firmware/pull/18450)) {#led-callback-refactor}
96 98
97_RGB Matrix_ and _LED Matrix_ Indicator display code was traditionally difficult to override in keymaps as they did not follow the standard pattern of `bool *_kb()` deferring to `bool *_user()` functions, allowing signalling to the higher level that processing had already been done. 99_RGB Matrix_ and _LED Matrix_ Indicator display code was traditionally difficult to override in keymaps as they did not follow the standard pattern of `bool *_kb()` deferring to `bool *_user()` functions, allowing signalling to the higher level that processing had already been done.
98 100
@@ -128,15 +130,15 @@ bool rgb_matrix_indicators_kb(void) {
128 130
129The equivalent transformations should be done for LED Matrix boards. 131The equivalent transformations should be done for LED Matrix boards.
130 132
131### Unicode mode refactoring :id=unicode-mode-renaming 133### Unicode mode refactoring {#unicode-mode-renaming}
132 134
133Unicode modes were renamed in order to prevent collision with equivalent keycodes. The available values for `UNICODE_SELECTED_MODES` changed -- see [Feature: Unicode](feature_unicode.md#setting-the-input-mode) for the new list of values and how to configure them. 135Unicode modes were renamed in order to prevent collision with equivalent keycodes. The available values for `UNICODE_SELECTED_MODES` changed -- see [Feature: Unicode](../feature_unicode#setting-the-input-mode) for the new list of values and how to configure them.
134 136
135## Notable core changes :id=notable-core 137## Notable core changes {#notable-core}
136 138
137This breaking changes cycle, a lot of the core changes are related to cleanup and refactoring -- commonly called "tech debt". 139This breaking changes cycle, a lot of the core changes are related to cleanup and refactoring -- commonly called "tech debt".
138 140
139### Keycodes refactoring :id=keycodes-overhaul-core-changes 141### Keycodes refactoring {#keycodes-overhaul-core-changes}
140 142
141We aren't going to list each and every change -- they're far too numerous -- instead, we'll just list the related PRs in order to convey just how wide-reaching these changes were: 143We aren't going to list each and every change -- they're far too numerous -- instead, we'll just list the related PRs in order to convey just how wide-reaching these changes were:
142 144
@@ -181,7 +183,7 @@ We aren't going to list each and every change -- they're far too numerous -- ins
181* Remove legacy sendstring keycodes ([#18749](https://github.com/qmk/qmk_firmware/pull/18749)) 183* Remove legacy sendstring keycodes ([#18749](https://github.com/qmk/qmk_firmware/pull/18749))
182* Reworked backlight keycodes. ([#18961](https://github.com/qmk/qmk_firmware/pull/18961)) 184* Reworked backlight keycodes. ([#18961](https://github.com/qmk/qmk_firmware/pull/18961))
183 185
184### Board Converters :id=board-converters 186### Board Converters {#board-converters}
185 187
186There was additional work in the space of board converters -- historically QMK allowed for "converting" a Pro Micro build to a QMK Proton-C build. The last few versions of QMK have added support for replacement boards much like the Proton-C, and this quarter was no exception: 188There was additional work in the space of board converters -- historically QMK allowed for "converting" a Pro Micro build to a QMK Proton-C build. The last few versions of QMK have added support for replacement boards much like the Proton-C, and this quarter was no exception:
187 189
@@ -191,9 +193,9 @@ There was additional work in the space of board converters -- historically QMK a
191* Add Elite-Pi converter ([#18236](https://github.com/qmk/qmk_firmware/pull/18236)) 193* Add Elite-Pi converter ([#18236](https://github.com/qmk/qmk_firmware/pull/18236))
192* Allow QK_MAKE to work with converters ([#18637](https://github.com/qmk/qmk_firmware/pull/18637)) 194* Allow QK_MAKE to work with converters ([#18637](https://github.com/qmk/qmk_firmware/pull/18637))
193 195
194See [Feature: Converters](feature_converters.md) for the full list of board conversions available. 196See [Feature: Converters](../feature_converters) for the full list of board conversions available.
195 197
196### Pointing and Digitizer device updates :id=pointing-and-digitizer 198### Pointing and Digitizer device updates {#pointing-and-digitizer}
197 199
198Both pointing devices and digitizer got a host of updates this cycle. Inertia, automatic mouse layers, fixes for preventing sleep... you even get more buttons with digitizers! 200Both pointing devices and digitizer got a host of updates this cycle. Inertia, automatic mouse layers, fixes for preventing sleep... you even get more buttons with digitizers!
199 201
@@ -207,7 +209,7 @@ Both pointing devices and digitizer got a host of updates this cycle. Inertia, a
207* Invert pointing device motion pin for cirque touchpads ([#18404](https://github.com/qmk/qmk_firmware/pull/18404)) 209* Invert pointing device motion pin for cirque touchpads ([#18404](https://github.com/qmk/qmk_firmware/pull/18404))
208* Refactor more host code (programmable button & digitizer) ([#18565](https://github.com/qmk/qmk_firmware/pull/18565)) 210* Refactor more host code (programmable button & digitizer) ([#18565](https://github.com/qmk/qmk_firmware/pull/18565))
209 211
210## Full changelist :id=full-changelist 212## Full changelist {#full-changelist}
211 213
212Core: 214Core:
213* quantum: led: split out led_update_ports() for customization of led behaviour ([#14452](https://github.com/qmk/qmk_firmware/pull/14452)) 215* quantum: led: split out led_update_ports() for customization of led behaviour ([#14452](https://github.com/qmk/qmk_firmware/pull/14452))
diff --git a/docs/ChangeLog/20230226.md b/docs/ChangeLog/20230226.md
index df5095ac7b..ee56068604 100644
--- a/docs/ChangeLog/20230226.md
+++ b/docs/ChangeLog/20230226.md
@@ -1,8 +1,8 @@
1# QMK Breaking Changes - 2023 February 26 Changelog 1# QMK Breaking Changes - 2023 February 26 Changelog
2 2
3## Changes Requiring User Action :id=changes-requiring-user-action 3## Changes Requiring User Action {#changes-requiring-user-action}
4 4
5### `IGNORE_MOD_TAP_INTERRUPT` behaviour changes ([#15741](https://github.com/qmk/qmk_firmware/pull/15741)) :id=i-m-t-i 5### `IGNORE_MOD_TAP_INTERRUPT` behaviour changes ([#15741](https://github.com/qmk/qmk_firmware/pull/15741)) {#i-m-t-i}
6 6
7`IGNORE_MOD_TAP_INTERRUPT_PER_KEY` has been removed and `IGNORE_MOD_TAP_INTERRUPT` deprecated as a stepping stone towards making `IGNORE_MOD_TAP_INTERRUPT` the new default behavior for mod-taps in the future. 7`IGNORE_MOD_TAP_INTERRUPT_PER_KEY` has been removed and `IGNORE_MOD_TAP_INTERRUPT` deprecated as a stepping stone towards making `IGNORE_MOD_TAP_INTERRUPT` the new default behavior for mod-taps in the future.
8 8
@@ -46,9 +46,9 @@ bool get_hold_on_other_key_press(uint16_t keycode, keyrecord_t *record) {
46} 46}
47``` 47```
48 48
49For more information, you are invited to read the sections on [IGNORE_MOD_TAP_INTERRUPT](tap_hold.md#ignore-mod-tap-interrupt) and [HOLD_ON_OTHER_KEY_PRESS](tap_hold.md#hold-on-other-key-press) in the page on [Tap-Hold configuration options](tap_hold.md). 49For more information, you are invited to read the sections on [IGNORE_MOD_TAP_INTERRUPT](../tap_hold#ignore-mod-tap-interrupt) and [HOLD_ON_OTHER_KEY_PRESS](../tap_hold#hold-on-other-key-press) in the page on [Tap-Hold configuration options](../tap_hold).
50 50
51### `TAPPING_FORCE_HOLD` => `QUICK_TAP_TERM` ([#17007](https://github.com/qmk/qmk_firmware/pull/17007)) :id=quick-tap-term 51### `TAPPING_FORCE_HOLD` => `QUICK_TAP_TERM` ([#17007](https://github.com/qmk/qmk_firmware/pull/17007)) {#quick-tap-term}
52 52
53`TAPPING_FORCE_HOLD` feature is now replaced by `QUICK_TAP_TERM`. Instead of turning off auto-repeat completely, user will have the option to configure a `QUICK_TAP_TERM` in milliseconds. When the user holds a tap-hold key after tapping it within `QUICK_TAP_TERM`, QMK will send the tap keycode to the host, enabling auto-repeat. 53`TAPPING_FORCE_HOLD` feature is now replaced by `QUICK_TAP_TERM`. Instead of turning off auto-repeat completely, user will have the option to configure a `QUICK_TAP_TERM` in milliseconds. When the user holds a tap-hold key after tapping it within `QUICK_TAP_TERM`, QMK will send the tap keycode to the host, enabling auto-repeat.
54 54
@@ -80,9 +80,9 @@ uint16_t get_quick_tap_term(uint16_t keycode, keyrecord_t *record) {
80} 80}
81``` 81```
82 82
83For more details, please read the updated documentation section on [Quick Tap Term](tap_hold.md#quick-tap-term). 83For more details, please read the updated documentation section on [Quick Tap Term](../tap_hold#quick-tap-term).
84 84
85### Leader Key Rework :id=leader-key-rework ([#19632](https://github.com/qmk/qmk_firmware/pull/19632)) 85### Leader Key Rework {#leader-key-rework ([#19632](https://github.com/qmk/qmk_firmware/pull/19632))}
86 86
87The Leader Key feature API has been significantly improved, along with some bugfixes and added tests. 87The Leader Key feature API has been significantly improved, along with some bugfixes and added tests.
88 88
@@ -106,9 +106,9 @@ void leader_end_user(void) {
106} 106}
107``` 107```
108 108
109For more information please see the [Leader Key documentation](feature_leader_key.md). 109For more information please see the [Leader Key documentation](../feature_leader_key).
110 110
111### Updated Keyboard Codebases :id=updated-keyboard-codebases 111### Updated Keyboard Codebases {#updated-keyboard-codebases}
112 112
113The following keyboards have had their source moved within QMK: 113The following keyboards have had their source moved within QMK:
114 114
@@ -130,7 +130,7 @@ The following keyboards have had their source moved within QMK:
130| the_uni | stenothe_uni | 130| the_uni | stenothe_uni |
131| xelus/xs60 | xelus/xs60/soldered | 131| xelus/xs60 | xelus/xs60/soldered |
132 132
133## Notable core changes :id=notable-core 133## Notable core changes {#notable-core}
134 134
135As per last breaking changes cycle, there has been _a lot_ of emphasis on behind-the-scenes changes, mainly around consolidation of core subsystems and constant values, as well as addressing tech debt. Whilst not outwardly visible, this cleanup and refactoring should start paying dividends as it simplifies future development and maintenance. 135As per last breaking changes cycle, there has been _a lot_ of emphasis on behind-the-scenes changes, mainly around consolidation of core subsystems and constant values, as well as addressing tech debt. Whilst not outwardly visible, this cleanup and refactoring should start paying dividends as it simplifies future development and maintenance.
136 136
@@ -142,7 +142,7 @@ A handful of examples:
142* Many more configuration options have moved into `info.json`, such as backlight, encoders 142* Many more configuration options have moved into `info.json`, such as backlight, encoders
143* Additional unit tests to ensure keycode behaviours don't accidentally change 143* Additional unit tests to ensure keycode behaviours don't accidentally change
144 144
145## Full changelist :id=full-changelist 145## Full changelist {#full-changelist}
146 146
147Core: 147Core:
148* Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY ([#15741](https://github.com/qmk/qmk_firmware/pull/15741)) 148* Remove IGNORE_MOD_TAP_INTERRUPT_PER_KEY in favour of HOLD_ON_OTHER_KEY_PRESS_PER_KEY ([#15741](https://github.com/qmk/qmk_firmware/pull/15741))
diff --git a/docs/ChangeLog/20230528.md b/docs/ChangeLog/20230528.md
index b4044d3109..40ab3a420c 100644
--- a/docs/ChangeLog/20230528.md
+++ b/docs/ChangeLog/20230528.md
@@ -1,6 +1,6 @@
1# QMK Breaking Changes - 2023 May 28 Changelog 1# QMK Breaking Changes - 2023 May 28 Changelog
2 2
3## Notable Changes :id=notable-changes 3## Notable Changes {#notable-changes}
4 4
5As per last breaking changes cycle, there has been _a lot_ of emphasis on behind-the-scenes changes, mainly around migration of configurables into `info.json` files, cleanup of `info.json` files, additional layout definitions for keyboards, adding support for general community layouts to keyboards, as well as addressing technical debt. 5As per last breaking changes cycle, there has been _a lot_ of emphasis on behind-the-scenes changes, mainly around migration of configurables into `info.json` files, cleanup of `info.json` files, additional layout definitions for keyboards, adding support for general community layouts to keyboards, as well as addressing technical debt.
6 6
@@ -20,11 +20,11 @@ Of note for keyboard designers:
20 * `encoder_map[][NUM_ENCODERS][2]` => `encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS]` 20 * `encoder_map[][NUM_ENCODERS][2]` => `encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS]`
21 * Users assumed the `2` referred to the number of encoders, rather than the number of directions (which is always 2) 21 * Users assumed the `2` referred to the number of encoders, rather than the number of directions (which is always 2)
22 22
23### Repeat last key ([#19700](https://github.com/qmk/qmk_firmware/pull/19700)) :id=repeat-last-key 23### Repeat last key ([#19700](https://github.com/qmk/qmk_firmware/pull/19700)) {#repeat-last-key}
24 24
25A new pair of keys has been added to QMK -- namely `QK_REPEAT_KEY` and `QK_ALT_REPEAT_KEY` (shortened: `QK_REP`/`QK_AREP`). These allow you to repeat the last key pressed, or in the case of the alternate key, press the "opposite" of the last key. For example, if you press `KC_LEFT`, pressing `QK_REPEAT_KEY` afterwards repeats `KC_LEFT`, but pressing `QK_ALT_REPEAT_KEY` instead sends `KC_RIGHT`. 25A new pair of keys has been added to QMK -- namely `QK_REPEAT_KEY` and `QK_ALT_REPEAT_KEY` (shortened: `QK_REP`/`QK_AREP`). These allow you to repeat the last key pressed, or in the case of the alternate key, press the "opposite" of the last key. For example, if you press `KC_LEFT`, pressing `QK_REPEAT_KEY` afterwards repeats `KC_LEFT`, but pressing `QK_ALT_REPEAT_KEY` instead sends `KC_RIGHT`.
26 26
27The full list of default alternate keys is available on the [Repeat Key](feature_repeat_key.md) documentation. 27The full list of default alternate keys is available on the [Repeat Key](../feature_repeat_key) documentation.
28 28
29To enable these keys, in your keymap's `rules.mk`, add: 29To enable these keys, in your keymap's `rules.mk`, add:
30 30
@@ -34,27 +34,27 @@ REPEAT_KEY_ENABLE = yes
34 34
35...and add them to your keymap. 35...and add them to your keymap.
36 36
37### User callback for pre process record ([#20584](https://github.com/qmk/qmk_firmware/pull/20584)) :id=user-callback-for-pre-process-record 37### User callback for pre process record ([#20584](https://github.com/qmk/qmk_firmware/pull/20584)) {#user-callback-for-pre-process-record}
38 38
39Two new boolean callback functions, `pre_process_record_kb` and `pre_process_record_user`, have been added. They are called at the beginning of `process_record`, right before `process_combo`. 39Two new boolean callback functions, `pre_process_record_kb` and `pre_process_record_user`, have been added. They are called at the beginning of `process_record`, right before `process_combo`.
40 40
41Similar to existing `*_kb` and `*_user` callback functions, returning `false` will halt further processing of key events. The `pre_process_record_user` function will allow user space opportunity to handle or capture an input before it undergoes quantum processing. For example, while action tapping is still resolving the tap or hold output of a mod-tap key, `pre_process_record_user` can capture the next key record of an input event that follows. That key record can be used to influence the [decision of the mod-tap](https://docs.qmk.fm/#/tap_hold) key that is currently undergoing quantum processing. 41Similar to existing `*_kb` and `*_user` callback functions, returning `false` will halt further processing of key events. The `pre_process_record_user` function will allow user space opportunity to handle or capture an input before it undergoes quantum processing. For example, while action tapping is still resolving the tap or hold output of a mod-tap key, `pre_process_record_user` can capture the next key record of an input event that follows. That key record can be used to influence the [decision of the mod-tap](../tap_hold) key that is currently undergoing quantum processing.
42 42
43### Consolidate modelm ([#14996](https://github.com/qmk/qmk_firmware/pull/14996) :id=consolidate-modelm 43### Consolidate modelm ([#14996](https://github.com/qmk/qmk_firmware/pull/14996) {#consolidate-modelm}
44 44
45Several build targets for the IBM Model M were cluttered in different folders. The maintainers of several Model M replacement controller projects agreed to consolidate them under one common folder. 45Several build targets for the IBM Model M were cluttered in different folders. The maintainers of several Model M replacement controller projects agreed to consolidate them under one common folder.
46 46
47The list of all moved keyboard locations is listed [below](20230528.md#updated-keyboard-codebases). 47The list of all moved keyboard locations is listed [below](20230528#updated-keyboard-codebases).
48 48
49## Changes Requiring User Action :id=changes-requiring-user-action 49## Changes Requiring User Action {#changes-requiring-user-action}
50 50
51### `IGNORE_MOD_TAP_INTERRUPT` behaviour changes ([#20211](https://github.com/qmk/qmk_firmware/pull/20211)) :id=i-m-t-i 51### `IGNORE_MOD_TAP_INTERRUPT` behaviour changes ([#20211](https://github.com/qmk/qmk_firmware/pull/20211)) {#i-m-t-i}
52 52
53Following up from the last breaking changes cycle, `IGNORE_MOD_TAP_INTERRUPT` has been removed and if present in keymap code, will now fail to build. The previous functionality for `IGNORE_MOD_TAP_INTERRUPT` is now default, and should you wish to revert to the old behaviour, you can use `HOLD_ON_OTHER_KEY_PRESS` instead. 53Following up from the last breaking changes cycle, `IGNORE_MOD_TAP_INTERRUPT` has been removed and if present in keymap code, will now fail to build. The previous functionality for `IGNORE_MOD_TAP_INTERRUPT` is now default, and should you wish to revert to the old behaviour, you can use `HOLD_ON_OTHER_KEY_PRESS` instead.
54 54
55For more information, you are invited to read the section on [HOLD_ON_OTHER_KEY_PRESS](tap_hold.md#hold-on-other-key-press) in the page on [Tap-Hold configuration options](tap_hold.md). 55For more information, you are invited to read the section on [HOLD_ON_OTHER_KEY_PRESS](../tap_hold#hold-on-other-key-press) in the page on [Tap-Hold configuration options](../tap_hold).
56 56
57### Updated Keyboard Codebases :id=updated-keyboard-codebases 57### Updated Keyboard Codebases {#updated-keyboard-codebases}
58 58
59| Old Keyboard Name | New Keyboard Name | 59| Old Keyboard Name | New Keyboard Name |
60|---------------------------------|-------------------------------------| 60|---------------------------------|-------------------------------------|
@@ -77,9 +77,9 @@ For more information, you are invited to read the section on [HOLD_ON_OTHER_KEY_
77| tronguylabs/m122_3270/teensy | ibm/model_m_122/m122_3270/teensy | 77| tronguylabs/m122_3270/teensy | ibm/model_m_122/m122_3270/teensy |
78| yugo_m/model_m_101 | ibm/model_m/yugo_m | 78| yugo_m/model_m_101 | ibm/model_m/yugo_m |
79 79
80## Notable core changes :id=notable-core 80## Notable core changes {#notable-core}
81 81
82### Encoder functionality fallback ([#20320](https://github.com/qmk/qmk_firmware/pull/20320)) :id=encoder-functionality-fallback 82### Encoder functionality fallback ([#20320](https://github.com/qmk/qmk_firmware/pull/20320)) {#encoder-functionality-fallback}
83 83
84For keyboards who have not yet been migrated to encoder map, a default set of encoder functionality is now enabled, gracefully degrading functionality depending on which flags are enabled by the keyboard: 84For keyboards who have not yet been migrated to encoder map, a default set of encoder functionality is now enabled, gracefully degrading functionality depending on which flags are enabled by the keyboard:
85 85
@@ -89,13 +89,13 @@ For keyboards who have not yet been migrated to encoder map, a default set of en
89 89
90Additionally, this ensures that builds on QMK Configurator produce some sort of usable encoder mapping. 90Additionally, this ensures that builds on QMK Configurator produce some sort of usable encoder mapping.
91 91
92### OLED Driver Improvements ([#20331](https://github.com/qmk/qmk_firmware/pull/20331)) :id=oled-driver-improvements 92### OLED Driver Improvements ([#20331](https://github.com/qmk/qmk_firmware/pull/20331)) {#oled-driver-improvements}
93 93
94The "classic" OLED driver picked up support for additional sizes of OLED displays, support for the SH1107 controller, and SPI-based OLED support. 94The "classic" OLED driver picked up support for additional sizes of OLED displays, support for the SH1107 controller, and SPI-based OLED support.
95 95
96Other configurable items are available and can be found on the [OLED Driver page](https://docs.qmk.fm/#/feature_oled_driver). 96Other configurable items are available and can be found on the [OLED Driver page](../feature_oled_driver).
97 97
98## Full changelist :id=full-changelist 98## Full changelist {#full-changelist}
99 99
100Core: 100Core:
101* Refactor `keyevent_t` for 1ms timing resolution ([#15847](https://github.com/qmk/qmk_firmware/pull/15847)) 101* Refactor `keyevent_t` for 1ms timing resolution ([#15847](https://github.com/qmk/qmk_firmware/pull/15847))
diff --git a/docs/ChangeLog/20230827.md b/docs/ChangeLog/20230827.md
index 12093d889f..aecbcb0d8f 100644
--- a/docs/ChangeLog/20230827.md
+++ b/docs/ChangeLog/20230827.md
@@ -1,14 +1,14 @@
1# QMK Breaking Changes - 2023 Aug 27 Changelog 1# QMK Breaking Changes - 2023 Aug 27 Changelog
2 2
3## Notable Changes :id=notable-changes 3## Notable Changes {#notable-changes}
4 4
5As per last few breaking changes cycles, there have been _a lot_ of behind-the-scenes changes, mainly around migration of configurables into `info.json` files, cleanup of `info.json` files, additional layout definitions for keyboards, adding support for general community layouts to keyboards, as well as addressing technical debt. 5As per last few breaking changes cycles, there have been _a lot_ of behind-the-scenes changes, mainly around migration of configurables into `info.json` files, cleanup of `info.json` files, additional layout definitions for keyboards, adding support for general community layouts to keyboards, as well as addressing technical debt.
6 6
7One thing to note for this release -- `qmk/qmk_firmware` is no longer accepting PRs for keymaps other than for manufacturer-supported keymaps. User keymap workflow has been documented [here](https://docs.qmk.fm/#/newbs) for several years. This change is to progressively reduce the maintenance burden on the project, and to allow us to focus on the core features of QMK. 7One thing to note for this release -- `qmk/qmk_firmware` is no longer accepting PRs for keymaps other than for manufacturer-supported keymaps. User keymap workflow has been documented [here](../newbs) for several years. This change is to progressively reduce the maintenance burden on the project, and to allow us to focus on the core features of QMK.
8 8
9Existing user keymaps and userspace areas will likely be relocated/removed in the future -- non-building keymaps and userspace will be first targets, likely during the new breaking changes cycle. We will provide more information on Discord regarding this initiative as it becomes available. 9Existing user keymaps and userspace areas will likely be relocated/removed in the future -- non-building keymaps and userspace will be first targets, likely during the new breaking changes cycle. We will provide more information on Discord regarding this initiative as it becomes available.
10 10
11### RGB Matrix optimizations ([#21134](https://github.com/qmk/qmk_firmware/pull/21134), [#21135](https://github.com/qmk/qmk_firmware/pull/21135)) :id=rgb-matrix-optimizations 11### RGB Matrix optimizations ([#21134](https://github.com/qmk/qmk_firmware/pull/21134), [#21135](https://github.com/qmk/qmk_firmware/pull/21135)) {#rgb-matrix-optimizations}
12 12
13Most RGB Matrix implementations now check whether or not RGB LED data has changed and skip transmission if it hasn't. This was measured to improve scan frequency in cases of static or infrequently-changing colors. 13Most RGB Matrix implementations now check whether or not RGB LED data has changed and skip transmission if it hasn't. This was measured to improve scan frequency in cases of static or infrequently-changing colors.
14 14
@@ -18,9 +18,9 @@ Some audio code relating to "notes" used `double` datatypes, which are implement
18 18
19AVR sees minimal (if any) benefit -- `double` was interpreted as `float` on AVR anyway. 19AVR sees minimal (if any) benefit -- `double` was interpreted as `float` on AVR anyway.
20 20
21## Changes Requiring User Action :id=changes-requiring-user-action 21## Changes Requiring User Action {#changes-requiring-user-action}
22 22
23### Updated Keyboard Codebases :id=updated-keyboard-codebases 23### Updated Keyboard Codebases {#updated-keyboard-codebases}
24 24
25| Old Keyboard Name | New Keyboard Name | 25| Old Keyboard Name | New Keyboard Name |
26|---------------------------------------|-------------------------------------| 26|---------------------------------------|-------------------------------------|
@@ -40,11 +40,11 @@ AVR sees minimal (if any) benefit -- `double` was interpreted as `float` on AVR
40| modelh | ibm/model_m/modelh | 40| modelh | ibm/model_m/modelh |
41| vinta | coarse/vinta | 41| vinta | coarse/vinta |
42 42
43### Remove encoder in-matrix workaround code ([#20389](https://github.com/qmk/qmk_firmware/pull/20389)) :id=remove-encoder-in-matrix-workaround-code 43### Remove encoder in-matrix workaround code ([#20389](https://github.com/qmk/qmk_firmware/pull/20389)) {#remove-encoder-in-matrix-workaround-code}
44 44
45Some keyboards "hacked" encoder support into spare slots in the key matrix in order to interoperate with VIA. This workaround is no longer necessary, and the code has been removed. If you have a keyboard that uses this workaround, you will need to update your keymap to use the new [Encoder Map](feature_encoders.md#encoder-map) API instead. 45Some keyboards "hacked" encoder support into spare slots in the key matrix in order to interoperate with VIA. This workaround is no longer necessary, and the code has been removed. If you have a keyboard that uses this workaround, you will need to update your keymap to use the new [Encoder Map](../feature_encoders#encoder-map) API instead.
46 46
47### Unicodemap keycodes rename ([#21092](https://github.com/qmk/qmk_firmware/pull/21092)) :id=unicodemap-keycodes-rename 47### Unicodemap keycodes rename ([#21092](https://github.com/qmk/qmk_firmware/pull/21092)) {#unicodemap-keycodes-rename}
48 48
49The Unicodemap keycodes have been renamed: 49The Unicodemap keycodes have been renamed:
50 50
@@ -53,11 +53,11 @@ The Unicodemap keycodes have been renamed:
53| `X(i)` | `UM(i)` | 53| `X(i)` | `UM(i)` |
54| `XP(i,j)` | `UP(i,j)` | 54| `XP(i,j)` | `UP(i,j)` |
55 55
56### Remove old OLED API code ([#21651](https://github.com/qmk/qmk_firmware/pull/21651)) :id=remove-old-oled-api-code 56### Remove old OLED API code ([#21651](https://github.com/qmk/qmk_firmware/pull/21651)) {#remove-old-oled-api-code}
57 57
58Old OLED code using `ssd1306.c` `ssd1306.h`, and `SSD1306OLED` and other similar files have been consolidated to use the standard OLED driver. External user keymaps will need to be updated to use the standard OLED driver accordingly. 58Old OLED code using `ssd1306.c` `ssd1306.h`, and `SSD1306OLED` and other similar files have been consolidated to use the standard OLED driver. External user keymaps will need to be updated to use the standard OLED driver accordingly.
59 59
60### Driver naming consolidation ([#21551](https://github.com/qmk/qmk_firmware/pull/21551), [#21558](https://github.com/qmk/qmk_firmware/pull/21558), [#21580](https://github.com/qmk/qmk_firmware/pull/21580), [#21594](https://github.com/qmk/qmk_firmware/pull/21594), [#21624](https://github.com/qmk/qmk_firmware/pull/21624), [#21710](https://github.com/qmk/qmk_firmware/pull/21710)) :id=driver-naming-consolidation 60### Driver naming consolidation ([#21551](https://github.com/qmk/qmk_firmware/pull/21551), [#21558](https://github.com/qmk/qmk_firmware/pull/21558), [#21580](https://github.com/qmk/qmk_firmware/pull/21580), [#21594](https://github.com/qmk/qmk_firmware/pull/21594), [#21624](https://github.com/qmk/qmk_firmware/pull/21624), [#21710](https://github.com/qmk/qmk_firmware/pull/21710)) {#driver-naming-consolidation}
61 61
62In most circumstances this won't affect users -- only keyboard designers with currently-unmerged boards. The only users affected are people who have modified existing keyboards in order to add/modify haptics, lighting, or bluetooth -- and only if the base keyboard did not configure them already. Driver naming has been modified to be lowercase. 62In most circumstances this won't affect users -- only keyboard designers with currently-unmerged boards. The only users affected are people who have modified existing keyboards in order to add/modify haptics, lighting, or bluetooth -- and only if the base keyboard did not configure them already. Driver naming has been modified to be lowercase.
63 63
@@ -116,7 +116,7 @@ Bluetooth (`BLUETOOTH_DRIVER` / `bluetooth.driver`):
116| `BluefruitLE` | `bluefruit_le` | 116| `BluefruitLE` | `bluefruit_le` |
117| `RN42` | `rn42` | 117| `RN42` | `rn42` |
118 118
119## Full changelist :id=full-changelist 119## Full changelist {#full-changelist}
120 120
121Core: 121Core:
122* On-each-release tap dance function ([#20255](https://github.com/qmk/qmk_firmware/pull/20255)) 122* On-each-release tap dance function ([#20255](https://github.com/qmk/qmk_firmware/pull/20255))
diff --git a/docs/ChangeLog/20231126.md b/docs/ChangeLog/20231126.md
index 61cff520c8..8a43bb0016 100644
--- a/docs/ChangeLog/20231126.md
+++ b/docs/ChangeLog/20231126.md
@@ -1,14 +1,14 @@
1# QMK Breaking Changes - 2023 November 26 Changelog 1# QMK Breaking Changes - 2023 November 26 Changelog
2 2
3## Notable Features :id=notable-features 3## Notable Features {#notable-features}
4 4
5As per last few breaking changes cycles, there have been _a lot_ of behind-the-scenes changes, mainly around consolidation of config into `info.json` files, cleanup of `info.json` files, cleaning up driver naming, as well as addressing technical debt. 5As per last few breaking changes cycles, there have been _a lot_ of behind-the-scenes changes, mainly around consolidation of config into `info.json` files, cleanup of `info.json` files, cleaning up driver naming, as well as addressing technical debt.
6 6
7As a followup to last cycle's [notable changes](20230827.md#notable-changes), as `qmk/qmk_firmware` is no longer accepting PRs for keymaps we're pleased to announce that storing and building keymaps externally from the normal QMK Firmware repository is now possible. This is done through the new [External Userspace](newbs_external_userspace.md) feature, more details below! 7As a followup to last cycle's [notable changes](20230827#notable-changes), as `qmk/qmk_firmware` is no longer accepting PRs for keymaps we're pleased to announce that storing and building keymaps externally from the normal QMK Firmware repository is now possible. This is done through the new [External Userspace](../newbs_external_userspace) feature, more details below!
8 8
9## Changes Requiring User Action :id=changes-requiring-user-action 9## Changes Requiring User Action {#changes-requiring-user-action}
10 10
11### Updated Keyboard Codebases :id=updated-keyboard-codebases 11### Updated Keyboard Codebases {#updated-keyboard-codebases}
12 12
13| Old Keyboard Name | New Keyboard Name | 13| Old Keyboard Name | New Keyboard Name |
14|---------------------------------------|-------------------------------| 14|---------------------------------------|-------------------------------|
@@ -29,29 +29,31 @@ As a followup to last cycle's [notable changes](20230827.md#notable-changes), as
29| studiokestra/line_tkl | studiokestra/line_friends_tkl | 29| studiokestra/line_tkl | studiokestra/line_friends_tkl |
30| ymdk/melody96 | ymdk/melody96/soldered | 30| ymdk/melody96 | ymdk/melody96/soldered |
31 31
32## Notable core changes :id=notable-core 32## Notable core changes {#notable-core}
33 33
34### External Userspace ([#22222](https://github.com/qmk/qmk_firmware/pull/22222)) 34### External Userspace ([#22222](https://github.com/qmk/qmk_firmware/pull/22222))
35 35
36As mentioned above, the new External Userspace feature allows for keymaps to be stored and built externally from the main QMK Firmware repository. This allows for keymaps to be stored separately -- usually in their own repository -- and for users to be able to maintain and build their keymaps without needing to fork the main QMK Firmware repository. 36As mentioned above, the new External Userspace feature allows for keymaps to be stored and built externally from the main QMK Firmware repository. This allows for keymaps to be stored separately -- usually in their own repository -- and for users to be able to maintain and build their keymaps without needing to fork the main QMK Firmware repository.
37 37
38See the [External Userspace documentation](newbs_external_userspace.md) for more details. 38See the [External Userspace documentation](../newbs_external_userspace) for more details.
39 39
40A significant portion of user keymaps have already been removed from `qmk/qmk_firmware` and more will follow in coming weeks. You can still recover your keymap from the tag [user-keymaps-still-present](https://github.com/qmk/qmk_firmware/tree/user-keymaps-still-present) if required -- a perfect time to migrate to the new External Userspace! 40A significant portion of user keymaps have already been removed from `qmk/qmk_firmware` and more will follow in coming weeks. You can still recover your keymap from the tag [user-keymaps-still-present](https://github.com/qmk/qmk_firmware/tree/user-keymaps-still-present) if required -- a perfect time to migrate to the new External Userspace!
41 41
42!> This feature is still in beta, and we're looking for feedback on it. Please try it out and let us know what you think -- a new `#help-userspace` channel has been set up on Discord. 42::: warning
43This feature is still in beta, and we're looking for feedback on it. Please try it out and let us know what you think -- a new `#help-userspace` channel has been set up on Discord.
44:::
43 45
44### Improve and Cleanup Shutdown callbacks ([#21060](https://github.com/qmk/qmk_firmware/pull/20160)) :id=improve-and-cleanup-shutdown-callbacks 46### Improve and Cleanup Shutdown callbacks ([#21060](https://github.com/qmk/qmk_firmware/pull/20160)) {#improve-and-cleanup-shutdown-callbacks}
45 47
46Shutdown callbacks at the keyboard level were never present, preventing safe shutdown sequencing for peripherals such as OLEDs, RGB LEDs, and other devices. This PR adds a new `shutdown_kb` function, as well as amending `shutdown_user`, allowing for safe shutdown of peripherals at both keyboard and keymap level. 48Shutdown callbacks at the keyboard level were never present, preventing safe shutdown sequencing for peripherals such as OLEDs, RGB LEDs, and other devices. This PR adds a new `shutdown_kb` function, as well as amending `shutdown_user`, allowing for safe shutdown of peripherals at both keyboard and keymap level.
47 49
48See the [Keyboard Shutdown/Reboot Code](custom_quantum_functions.md#keyboard-shutdown-reboot-code) documentation for more details. 50See the [Keyboard Shutdown/Reboot Code](../custom_quantum_functions#keyboard-shutdown-reboot-code) documentation for more details.
49 51
50### OLED Force Flush ([#20953](https://github.com/qmk/qmk_firmware/pull/20953)) :id=oled-force-flush 52### OLED Force Flush ([#20953](https://github.com/qmk/qmk_firmware/pull/20953)) {#oled-force-flush}
51 53
52Along with the new `shutdown_kb` function, a new API `oled_render_dirty(bool)` function has been added. This allows OLED contents to be written deterministically when supplied with `true` -- that is, the OLED will be updated immediately, rather than waiting for the next OLED update cycle. This allows for OLEDs to show things such as "BOOTLOADER MODE" and the like if resetting to bootloader from QMK. 54Along with the new `shutdown_kb` function, a new API `oled_render_dirty(bool)` function has been added. This allows OLED contents to be written deterministically when supplied with `true` -- that is, the OLED will be updated immediately, rather than waiting for the next OLED update cycle. This allows for OLEDs to show things such as "BOOTLOADER MODE" and the like if resetting to bootloader from QMK.
53 55
54### Switch statement helpers for keycode ranges ([#20059](https://github.com/qmk/qmk_firmware/pull/20059)) :id=switch-statement-helpers-for-keycode-ranges 56### Switch statement helpers for keycode ranges ([#20059](https://github.com/qmk/qmk_firmware/pull/20059)) {#switch-statement-helpers-for-keycode-ranges}
55 57
56Predefined ranges usable within switch statements have been added for groups of similar keycodes, where people who wish to handle entire blocks at once can do so. This allows keymaps to be immune to changes in keycode values, and also allows for more efficient code generation. 58Predefined ranges usable within switch statements have been added for groups of similar keycodes, where people who wish to handle entire blocks at once can do so. This allows keymaps to be immune to changes in keycode values, and also allows for more efficient code generation.
57 59
@@ -98,17 +100,17 @@ Becomes:
98 /* do stuff with basic and modifier keycodes */ 100 /* do stuff with basic and modifier keycodes */
99``` 101```
100 102
101### Quantum Painter OLED support ([#19997](https://github.com/qmk/qmk_firmware/pull/19997)) :id=quantum-painter-oled-support 103### Quantum Painter OLED support ([#19997](https://github.com/qmk/qmk_firmware/pull/19997)) {#quantum-painter-oled-support}
102 104
103Quantum Painter has picked up support for SH1106 displays -- commonly seen as 128x64 OLEDs. Support for both I2C and SPI displays is available. 105Quantum Painter has picked up support for SH1106 displays -- commonly seen as 128x64 OLEDs. Support for both I2C and SPI displays is available.
104 106
105If you're already using OLED through `OLED_DRIVER_ENABLE = yes` or equivalent in `info.json` and wish to use Quantum Painter instead, you'll need to disable the old OLED system, instead enabling Quantum Painter as well as enabling the appropriate SH1106 driver. See the [Quantum Painter driver documentation](quantum_painter.md#quantum-painter-drivers) for more details. The old OLED driver is still available, and keymaps do not require migrating to Quantum Painter if you don't want to do so. 107If you're already using OLED through `OLED_DRIVER_ENABLE = yes` or equivalent in `info.json` and wish to use Quantum Painter instead, you'll need to disable the old OLED system, instead enabling Quantum Painter as well as enabling the appropriate SH1106 driver. See the [Quantum Painter driver documentation](../quantum_painter#quantum-painter-drivers) for more details. The old OLED driver is still available, and keymaps do not require migrating to Quantum Painter if you don't want to do so.
106 108
107### RGB/LED lighting driver naming and cleanup ([#21890](https://github.com/qmk/qmk_firmware/pull/21890), [#21891](https://github.com/qmk/qmk_firmware/pull/21891), [#21892](https://github.com/qmk/qmk_firmware/pull/21892), [#21903](https://github.com/qmk/qmk_firmware/pull/21903), [#21904](https://github.com/qmk/qmk_firmware/pull/21904), [#21905](https://github.com/qmk/qmk_firmware/pull/21905), [#21918](https://github.com/qmk/qmk_firmware/pull/21918), [#21929](https://github.com/qmk/qmk_firmware/pull/21929), [#21938](https://github.com/qmk/qmk_firmware/pull/21938), [#22004](https://github.com/qmk/qmk_firmware/pull/22004), [#22008](https://github.com/qmk/qmk_firmware/pull/22008), [#22009](https://github.com/qmk/qmk_firmware/pull/22009), [#22071](https://github.com/qmk/qmk_firmware/pull/22071), [#22090](https://github.com/qmk/qmk_firmware/pull/22090), [#22099](https://github.com/qmk/qmk_firmware/pull/22099), [#22126](https://github.com/qmk/qmk_firmware/pull/22126), [#22133](https://github.com/qmk/qmk_firmware/pull/22133), [#22163](https://github.com/qmk/qmk_firmware/pull/22163), [#22200](https://github.com/qmk/qmk_firmware/pull/22200), [#22308](https://github.com/qmk/qmk_firmware/pull/22308), [#22309](https://github.com/qmk/qmk_firmware/pull/22309), [#22311](https://github.com/qmk/qmk_firmware/pull/22311), [#22325](https://github.com/qmk/qmk_firmware/pull/22325), [#22365](https://github.com/qmk/qmk_firmware/pull/22365), [#22379](https://github.com/qmk/qmk_firmware/pull/22379), [#22380](https://github.com/qmk/qmk_firmware/pull/22380), [#22381](https://github.com/qmk/qmk_firmware/pull/22381), [#22383](https://github.com/qmk/qmk_firmware/pull/22383), [#22436](https://github.com/qmk/qmk_firmware/pull/22436)) 109### RGB/LED lighting driver naming and cleanup ([#21890](https://github.com/qmk/qmk_firmware/pull/21890), [#21891](https://github.com/qmk/qmk_firmware/pull/21891), [#21892](https://github.com/qmk/qmk_firmware/pull/21892), [#21903](https://github.com/qmk/qmk_firmware/pull/21903), [#21904](https://github.com/qmk/qmk_firmware/pull/21904), [#21905](https://github.com/qmk/qmk_firmware/pull/21905), [#21918](https://github.com/qmk/qmk_firmware/pull/21918), [#21929](https://github.com/qmk/qmk_firmware/pull/21929), [#21938](https://github.com/qmk/qmk_firmware/pull/21938), [#22004](https://github.com/qmk/qmk_firmware/pull/22004), [#22008](https://github.com/qmk/qmk_firmware/pull/22008), [#22009](https://github.com/qmk/qmk_firmware/pull/22009), [#22071](https://github.com/qmk/qmk_firmware/pull/22071), [#22090](https://github.com/qmk/qmk_firmware/pull/22090), [#22099](https://github.com/qmk/qmk_firmware/pull/22099), [#22126](https://github.com/qmk/qmk_firmware/pull/22126), [#22133](https://github.com/qmk/qmk_firmware/pull/22133), [#22163](https://github.com/qmk/qmk_firmware/pull/22163), [#22200](https://github.com/qmk/qmk_firmware/pull/22200), [#22308](https://github.com/qmk/qmk_firmware/pull/22308), [#22309](https://github.com/qmk/qmk_firmware/pull/22309), [#22311](https://github.com/qmk/qmk_firmware/pull/22311), [#22325](https://github.com/qmk/qmk_firmware/pull/22325), [#22365](https://github.com/qmk/qmk_firmware/pull/22365), [#22379](https://github.com/qmk/qmk_firmware/pull/22379), [#22380](https://github.com/qmk/qmk_firmware/pull/22380), [#22381](https://github.com/qmk/qmk_firmware/pull/22381), [#22383](https://github.com/qmk/qmk_firmware/pull/22383), [#22436](https://github.com/qmk/qmk_firmware/pull/22436))
108 110
109As you can probably tell by the list of PRs just above, there has been a lot of cleanup and consolidation this cycle when it comes to RGB/LED lighting drivers. The number of changes is too large to list here, but the general theme has been focusing on consistency of naming, both of drivers themselves and their respective implementation and configuration. Most changes only affect keyboard designers -- if you find that your in-development keyboard is no longer building due to naming of defines changing, your best bet is to refer to another board already in the repository which has had the changes applied. 111As you can probably tell by the list of PRs just above, there has been a lot of cleanup and consolidation this cycle when it comes to RGB/LED lighting drivers. The number of changes is too large to list here, but the general theme has been focusing on consistency of naming, both of drivers themselves and their respective implementation and configuration. Most changes only affect keyboard designers -- if you find that your in-development keyboard is no longer building due to naming of defines changing, your best bet is to refer to another board already in the repository which has had the changes applied.
110 112
111### Peripheral subsystem enabling ([#22253](https://github.com/qmk/qmk_firmware/pull/22253), [#22448](https://github.com/qmk/qmk_firmware/pull/22448), [#22106](https://github.com/qmk/qmk_firmware/pull/22106)) :id=peripheral-subsystem-enabling 113### Peripheral subsystem enabling ([#22253](https://github.com/qmk/qmk_firmware/pull/22253), [#22448](https://github.com/qmk/qmk_firmware/pull/22448), [#22106](https://github.com/qmk/qmk_firmware/pull/22106)) {#peripheral-subsystem-enabling}
112 114
113When enabling peripherals such as I2C, SPI, or Analog/ADC, some required manual inclusion of source files in order to provide driver support, and in some cases, when multiple drivers were using the same underlying peripheral, files were being added to the build multiple times. 115When enabling peripherals such as I2C, SPI, or Analog/ADC, some required manual inclusion of source files in order to provide driver support, and in some cases, when multiple drivers were using the same underlying peripheral, files were being added to the build multiple times.
114 116
@@ -125,11 +127,11 @@ For a concrete example, users or keyboard designers who previously added `SRC +=
125| `UART_DRIVER_REQUIRED = yes` | `SRC += uart.c` | 127| `UART_DRIVER_REQUIRED = yes` | `SRC += uart.c` |
126| `WS2812_DRIVER_REQUIRED = yes` | `SRC += ws2812.c` | 128| `WS2812_DRIVER_REQUIRED = yes` | `SRC += ws2812.c` |
127 129
128### NKRO on V-USB boards ([#22398](https://github.com/qmk/qmk_firmware/pull/22398)) :id=vusb-nkro 130### NKRO on V-USB boards ([#22398](https://github.com/qmk/qmk_firmware/pull/22398)) {#vusb-nkro}
129 131
130NKRO is now available for ATmega32A and 328P-based keyboards (including PS2AVRGB/Bootmapper boards), thanks to some internal refactoring and cleanup. To enable it, the process is the same as always - add `NKRO_ENABLE = yes` to your `rules.mk`, then assign and press the `NK_TOGG` keycode to switch modes. 132NKRO is now available for ATmega32A and 328P-based keyboards (including PS2AVRGB/Bootmapper boards), thanks to some internal refactoring and cleanup. To enable it, the process is the same as always - add `NKRO_ENABLE = yes` to your `rules.mk`, then assign and press the `NK_TOGG` keycode to switch modes.
131 133
132## Full changelist :id=full-changelist 134## Full changelist {#full-changelist}
133 135
134Core: 136Core:
135* Compilation warning if both `keymap.json` and `keymap.c` exist ([#19939](https://github.com/qmk/qmk_firmware/pull/19939)) 137* Compilation warning if both `keymap.json` and `keymap.c` exist ([#19939](https://github.com/qmk/qmk_firmware/pull/19939))
diff --git a/docs/ChangeLog/20240225.md b/docs/ChangeLog/20240225.md
index 779b778490..f4103c594e 100644
--- a/docs/ChangeLog/20240225.md
+++ b/docs/ChangeLog/20240225.md
@@ -1,6 +1,6 @@
1# QMK Breaking Changes - 2024 February 25 Changelog 1# QMK Breaking Changes - 2024 February 25 Changelog
2 2
3## Notable Features :id=notable-features 3## Notable Features {#notable-features}
4 4
5_0.24.0_ is mainly a maintenance release of QMK Firmware -- as per last few breaking changes cycles, there have been a lot of behind-the-scenes changes, mainly: 5_0.24.0_ is mainly a maintenance release of QMK Firmware -- as per last few breaking changes cycles, there have been a lot of behind-the-scenes changes, mainly:
6 6
@@ -10,17 +10,17 @@ _0.24.0_ is mainly a maintenance release of QMK Firmware -- as per last few brea
10* keyboard relocations 10* keyboard relocations
11* addressing technical debt 11* addressing technical debt
12 12
13## Changes Requiring User Action :id=changes-requiring-user-action 13## Changes Requiring User Action {#changes-requiring-user-action}
14 14
15### Windows Driver Changes ([QMK Toolbox 0.3.0 Release](https://github.com/qmk/qmk_toolbox/releases/tag/0.3.0)) 15### Windows Driver Changes ([QMK Toolbox 0.3.0 Release](https://github.com/qmk/qmk_toolbox/releases/tag/0.3.0))
16 16
17Flashing keyboards that target `atmel-dfu` or `qmk-dfu` on Windows using `qmk flash` or QMK Toolbox have traditionally used _libusb_ for access to the DFU USB device. Since QMK Toolbox 0.3.0, this has changed to WinUSB. 17Flashing keyboards that target `atmel-dfu` or `qmk-dfu` on Windows using `qmk flash` or QMK Toolbox have traditionally used _libusb_ for access to the DFU USB device. Since QMK Toolbox 0.3.0, this has changed to WinUSB.
18 18
19If you update QMK Toolbox or update QMK MSYS, you may find that flashing Atmel DFU keyboards no longer functions as intended. If you strike such issues when flashing new firmware, you will need to replace the _libusb_ driver with _WinUSB_ using Zadig. You can follow the [Recovering from Installation to Wrong Device](driver_installation_zadig.md#recovering-from-installation-to-wrong-device) instructions to replace the driver associated with the Atmel DFU bootloader, skipping the section about removal as Zadig will safely replace the driver instead. Please ensure your keyboard is in bootloader mode and has _libusb_ as the existing driver before attempting to use Zadig to replace the driver. If instead you see _HidUsb_ you're not in bootloader mode and should not continue with driver replacement. 19If you update QMK Toolbox or update QMK MSYS, you may find that flashing Atmel DFU keyboards no longer functions as intended. If you strike such issues when flashing new firmware, you will need to replace the _libusb_ driver with _WinUSB_ using Zadig. You can follow the [Recovering from Installation to Wrong Device](../driver_installation_zadig#recovering-from-installation-to-wrong-device) instructions to replace the driver associated with the Atmel DFU bootloader, skipping the section about removal as Zadig will safely replace the driver instead. Please ensure your keyboard is in bootloader mode and has _libusb_ as the existing driver before attempting to use Zadig to replace the driver. If instead you see _HidUsb_ you're not in bootloader mode and should not continue with driver replacement.
20 20
21### Updated Keyboard Codebases :id=updated-keyboard-codebases 21### Updated Keyboard Codebases {#updated-keyboard-codebases}
22 22
23One note with updated keyboard names -- historical keyboard names are still considered valid when using [External Userspace](newbs_external_userspace.md) for builds. If you're already using External Userspace, you do not need to move your keymap inside your repository. 23One note with updated keyboard names -- historical keyboard names are still considered valid when using [External Userspace](../newbs_external_userspace) for builds. If you're already using External Userspace, you do not need to move your keymap inside your repository.
24 24
25| Old Keyboard Name | New Keyboard Name | 25| Old Keyboard Name | New Keyboard Name |
26|-------------------------|---------------------------------| 26|-------------------------|---------------------------------|
@@ -77,9 +77,9 @@ One note with updated keyboard names -- historical keyboard names are still cons
77| z12 | zigotica/z12 | 77| z12 | zigotica/z12 |
78| z34 | zigotica/z34 | 78| z34 | zigotica/z34 |
79 79
80## Notable core changes :id=notable-core 80## Notable core changes {#notable-core}
81 81
82### Renaming Arduino-style GPIO pin functions ([#23085](https://github.com/qmk/qmk_firmware/pull/23085), [#23093](https://github.com/qmk/qmk_firmware/pull/23093)) :id=gpio-rename 82### Renaming Arduino-style GPIO pin functions ([#23085](https://github.com/qmk/qmk_firmware/pull/23085), [#23093](https://github.com/qmk/qmk_firmware/pull/23093)) {#gpio-rename}
83 83
84QMK has long used Arduino-style GPIO naming conventions. This has been confusing for users, as over time they've had new variations added, as well as users mistakenly thinking that QMK supports the rest of the Arduino ecosystem. 84QMK has long used Arduino-style GPIO naming conventions. This has been confusing for users, as over time they've had new variations added, as well as users mistakenly thinking that QMK supports the rest of the Arduino ecosystem.
85 85
@@ -110,17 +110,17 @@ Much like the GPIO refactoring, I2C APIs were also updated to conform to QMK nam
110| `i2c_writeReg()` | `i2c_write_register()` | 110| `i2c_writeReg()` | `i2c_write_register()` |
111| `i2c_writeReg16()` | `i2c_write_register16()` | 111| `i2c_writeReg16()` | `i2c_write_register16()` |
112 112
113### Renaming _Bootmagic Lite_ => _Bootmagic_ ([#22970](https://github.com/qmk/qmk_firmware/pull/22970), [#22979](https://github.com/qmk/qmk_firmware/pull/22979)) :id=bootmagic-rename 113### Renaming _Bootmagic Lite_ => _Bootmagic_ ([#22970](https://github.com/qmk/qmk_firmware/pull/22970), [#22979](https://github.com/qmk/qmk_firmware/pull/22979)) {#bootmagic-rename}
114 114
115Bootmagic "Lite" had no real meaning once the historical Bootmagic "Full" was deprecated and removed. Any references to _Bootmagic Lite_ should now just refer to _Bootmagic_. We hope we got the majority of the code and the documentation, so if you find any more, let us know! 115Bootmagic "Lite" had no real meaning once the historical Bootmagic "Full" was deprecated and removed. Any references to _Bootmagic Lite_ should now just refer to _Bootmagic_. We hope we got the majority of the code and the documentation, so if you find any more, let us know!
116 116
117### Threshold for automatic mouse layer activation ([#21398](https://github.com/qmk/qmk_firmware/pull/21398)) :id=auto-mouse-layer 117### Threshold for automatic mouse layer activation ([#21398](https://github.com/qmk/qmk_firmware/pull/21398)) {#auto-mouse-layer}
118 118
119In some cases, accidental automatic activation of the mouse layer made it difficult to continue typing, such as when brushing across a trackball. `AUTO_MOUSE_THRESHOLD` is now a configurable option in `config.h` which allows for specifying what the movement threshold is before automatically activating the mouse layer. 119In some cases, accidental automatic activation of the mouse layer made it difficult to continue typing, such as when brushing across a trackball. `AUTO_MOUSE_THRESHOLD` is now a configurable option in `config.h` which allows for specifying what the movement threshold is before automatically activating the mouse layer.
120 120
121### DIP Switch Mapping ([#22543](https://github.com/qmk/qmk_firmware/pull/22543)) :id=dip-switch-map 121### DIP Switch Mapping ([#22543](https://github.com/qmk/qmk_firmware/pull/22543)) {#dip-switch-map}
122 122
123Much like Encoder Mapping, DIP Switch Mapping allows for specifying a table of actions to execute when a DIP switch state changes. See the [DIP Switch Documentation](feature_dip_switch.md#dip-switch-map) for more information. 123Much like Encoder Mapping, DIP Switch Mapping allows for specifying a table of actions to execute when a DIP switch state changes. See the [DIP Switch Documentation](../feature_dip_switch#dip-switch-map) for more information.
124 124
125```c 125```c
126#if defined(DIP_SWITCH_MAP_ENABLE) 126#if defined(DIP_SWITCH_MAP_ENABLE)
@@ -131,7 +131,7 @@ const uint16_t PROGMEM dip_switch_map[NUM_DIP_SWITCHES][NUM_DIP_STATES] = {
131#endif 131#endif
132``` 132```
133 133
134### Quantum Painter updates ([#18521](https://github.com/qmk/qmk_firmware/pull/18521), [#20645](https://github.com/qmk/qmk_firmware/pull/20645), [#22358](https://github.com/qmk/qmk_firmware/pull/22358)) :id=qp-updates 134### Quantum Painter updates ([#18521](https://github.com/qmk/qmk_firmware/pull/18521), [#20645](https://github.com/qmk/qmk_firmware/pull/20645), [#22358](https://github.com/qmk/qmk_firmware/pull/22358)) {#qp-updates}
135 135
136Quantum Painter picked up support for the following: 136Quantum Painter picked up support for the following:
137 137
@@ -141,7 +141,7 @@ Quantum Painter picked up support for the following:
141 141
142Quantum Painter now supports the majority of common OLED panels supported by the basic OLED driver, so if you're using an ARM-based board you may find Quantum Painter a much more feature-rich API in comparison. 142Quantum Painter now supports the majority of common OLED panels supported by the basic OLED driver, so if you're using an ARM-based board you may find Quantum Painter a much more feature-rich API in comparison.
143 143
144## Full changelist :id=full-changelist 144## Full changelist {#full-changelist}
145 145
146Core: 146Core:
147* [Driver] ILI9486 on Quantum Painter ([#18521](https://github.com/qmk/qmk_firmware/pull/18521)) 147* [Driver] ILI9486 on Quantum Painter ([#18521](https://github.com/qmk/qmk_firmware/pull/18521))
diff --git a/docs/ChangeLog/20240526.md b/docs/ChangeLog/20240526.md
index 4cf185234c..b5e5b3b693 100644
--- a/docs/ChangeLog/20240526.md
+++ b/docs/ChangeLog/20240526.md
@@ -1,14 +1,14 @@
1# QMK Breaking Changes - 2024 May 26 Changelog 1# QMK Breaking Changes - 2024 May 26 Changelog
2 2
3## Notable Features :id=notable-features 3## Notable Features {#notable-features}
4 4
5May 2024 brings about another heavy maintenance release of QMK. Of the 209 PRs created this breaking changes cycle against the `develop` branch, 174 behind-the-scenes PRs (83%!) were aimed at converting, consolidating, and cleaning up keyboards and their configuration data. Not the most glamorous work, but it means QMK is in a much more manageable spot than what it was 3 months prior. The work steadily continues! 5May 2024 brings about another heavy maintenance release of QMK. Of the 209 PRs created this breaking changes cycle against the `develop` branch, 174 behind-the-scenes PRs (83%!) were aimed at converting, consolidating, and cleaning up keyboards and their configuration data. Not the most glamorous work, but it means QMK is in a much more manageable spot than what it was 3 months prior. The work steadily continues!
6 6
7## Changes Requiring User Action :id=changes-requiring-user-action 7## Changes Requiring User Action {#changes-requiring-user-action}
8 8
9### Updated Keyboard Codebases :id=updated-keyboard-codebases 9### Updated Keyboard Codebases {#updated-keyboard-codebases}
10 10
11One note with updated keyboard names -- historical keyboard names are still considered valid when using [External Userspace](newbs_external_userspace.md) for builds. If you're already using External Userspace, you do not need to move your keymap inside your repository. 11One note with updated keyboard names -- historical keyboard names are still considered valid when using [External Userspace](../newbs_external_userspace) for builds. If you're already using External Userspace, you do not need to move your keymap inside your repository.
12 12
13| Old Keyboard Name | New Keyboard Name | 13| Old Keyboard Name | New Keyboard Name |
14|------------------------------|-----------------------------------| 14|------------------------------|-----------------------------------|
@@ -40,7 +40,7 @@ A bunch of legacy keycodes have been removed -- check [the affected keycodes](ht
40 40
41The latest of these were officially deprecated within QMK in the August 2023 breaking changes -- the new keycodes are the way forward. 41The latest of these were officially deprecated within QMK in the August 2023 breaking changes -- the new keycodes are the way forward.
42 42
43### P3D Spacey Layout Updates ([#23329](https://github.com/qmk/qmk_firmware/pull/23329)) :id=spacey-layout-updates 43### P3D Spacey Layout Updates ([#23329](https://github.com/qmk/qmk_firmware/pull/23329)) {#spacey-layout-updates}
44 44
45This PR removed the `LAYOUT` macro that was configured for the Spacey. 45This PR removed the `LAYOUT` macro that was configured for the Spacey.
46If you have a keymap for this keyboard, you will need to update your 46If you have a keymap for this keyboard, you will need to update your
@@ -54,7 +54,7 @@ keymap using the following steps:
544. Move the keycode for the Right Arrow to the end of the Shift row, 544. Move the keycode for the Right Arrow to the end of the Shift row,
55 after the Down Arrow key. 55 after the Down Arrow key.
56 56
57### MechKeys ACR60 Layout Updates ([#23309](https://github.com/qmk/qmk_firmware/pull/23309)) :id=acr60-layout-updates 57### MechKeys ACR60 Layout Updates ([#23309](https://github.com/qmk/qmk_firmware/pull/23309)) {#acr60-layout-updates}
58 58
59This PR removed and changed some of the layouts that were configured for the ACR60. If you use one of the following layouts, you will need to update your keymap: 59This PR removed and changed some of the layouts that were configured for the ACR60. If you use one of the following layouts, you will need to update your keymap:
60 60
@@ -63,17 +63,17 @@ This PR removed and changed some of the layouts that were configured for the ACR
63- [`LAYOUT_directional`](#layout-directional) 63- [`LAYOUT_directional`](#layout-directional)
64- [`LAYOUT_mitchsplit`](#layout-mitchsplit) 64- [`LAYOUT_mitchsplit`](#layout-mitchsplit)
65 65
66#### `LAYOUT_hhkb` :id=acr60-layout-hhkb 66#### `LAYOUT_hhkb` {#acr60-layout-hhkb}
67 67
681. Change your layout macro to `LAYOUT_60_hhkb`. 681. Change your layout macro to `LAYOUT_60_hhkb`.
691. Remove any keycodes for the key between Left Shift and QWERTY Z. 691. Remove any keycodes for the key between Left Shift and QWERTY Z.
70 70
71#### `LAYOUT_true_hhkb` :id=acr60-layout-true-hhkb 71#### `LAYOUT_true_hhkb` {#acr60-layout-true-hhkb}
72 72
731. Change your layout macro to `LAYOUT_60_true_hhkb`. 731. Change your layout macro to `LAYOUT_60_true_hhkb`.
741. Remove any keycodes for the key between Left Shift and QWERTY Z. 741. Remove any keycodes for the key between Left Shift and QWERTY Z.
75 75
76#### `LAYOUT_directional` :id=acr60-layout-directional 76#### `LAYOUT_directional` {#acr60-layout-directional}
77 77
781. Change your layout macro to `LAYOUT_60_ansi_arrow_split_bs`. 781. Change your layout macro to `LAYOUT_60_ansi_arrow_split_bs`.
791. Remove any keycodes for the key between Left Shift and QWERTY Z. 791. Remove any keycodes for the key between Left Shift and QWERTY Z.
@@ -81,16 +81,16 @@ This PR removed and changed some of the layouts that were configured for the ACR
81 81
82If you need split spacebars, you may implement `LAYOUT_60_ansi_arrow_split_space_split_bs` and change your layout to it, removing the keycode between Left Shift and QWERTY Z. 82If you need split spacebars, you may implement `LAYOUT_60_ansi_arrow_split_space_split_bs` and change your layout to it, removing the keycode between Left Shift and QWERTY Z.
83 83
84#### `LAYOUT_mitchsplit` :id=acr60-layout-mitchsplit 84#### `LAYOUT_mitchsplit` {#acr60-layout-mitchsplit}
85 85
861. Use `LAYOUT_60_ansi_split_space_split_rshift`. 861. Use `LAYOUT_60_ansi_split_space_split_rshift`.
87 87
88## Notable core changes :id=notable-core 88## Notable core changes {#notable-core}
89 89
90### Introduction of `keyboard.json` ([22891](https://github.com/qmk/qmk_firmware/pull/22891)) :id=keyboard-json 90### Introduction of `keyboard.json` ([22891](https://github.com/qmk/qmk_firmware/pull/22891)) {#keyboard-json}
91 91
92One longer term goal of QMK is increased maintainability. 92One longer term goal of QMK is increased maintainability.
93As part of the continued push towards [Data Driven Configuration](data_driven_config.md), the build system has been updated to simplify the existing codebase, and power future workflows. 93As part of the continued push towards [Data Driven Configuration](../data_driven_config), the build system has been updated to simplify the existing codebase, and power future workflows.
94 94
95The `keyboard.json` configuration file allows the support of a single data file for keyboard level config. 95The `keyboard.json` configuration file allows the support of a single data file for keyboard level config.
96 96
@@ -109,7 +109,7 @@ Essentially, changes were made in the internals of how QMK interacts with USB fo
109 109
110Compliance checks were run against QMK firmwares for the most popular ARM microcontrollers, as well as suspend/resume tests. As far as we can tell, a whole host of hard-to-reproduce issues are mitigated by this change. 110Compliance checks were run against QMK firmwares for the most popular ARM microcontrollers, as well as suspend/resume tests. As far as we can tell, a whole host of hard-to-reproduce issues are mitigated by this change.
111 111
112## Full changelist :id=full-changelist 112## Full changelist {#full-changelist}
113 113
114Core: 114Core:
115* Refactor vusb to protocol use pre/post task ([#14944](https://github.com/qmk/qmk_firmware/pull/14944)) 115* Refactor vusb to protocol use pre/post task ([#14944](https://github.com/qmk/qmk_firmware/pull/14944))
generated by cgit v1.2.3 (git 2.25.1) at 2026-09-03 08:01:58 +0000