<feed xmlns='http://www.w3.org/2005/Atom'>
<title>qmk_firmware/docs/understanding_qmk.md, branch master</title>
<subtitle>QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)</subtitle>
<link rel='alternate' type='text/html' href='https://git.vineetk.net/qmk_firmware/'/>
<entry>
<title>Deprecate LAYOUT() macro in favor of JSON matrix definitions</title>
<updated>2025-11-04T07:06:56+00:00</updated>
<author>
<name>Andrew C</name>
<email>47721334+polarbearhoodie@users.noreply.github.com</email>
</author>
<published>2025-11-04T07:06:56+00:00</published>
<link rel='alternate' type='text/html' href='https://git.vineetk.net/qmk_firmware/commit/?id=a1096e1dec7abae4c3cb957c992b7ac47877fe83'/>
<id>a1096e1dec7abae4c3cb957c992b7ac47877fe83</id>
<content type='text'>
* Indicate &lt;keyboard&gt;.h LAYOUT() deprecation in understanding_qmk.md

Initial documentation uses &lt;keyboard&gt;.json to define matrix pin definitions, rather than having users #define the LAYOUT() macro in &lt;keyboard&gt;.h  -  This change brings this docs inline with the [porting_guidelines](https://docs.qmk.fm/porting_your_keyboard_to_qmk),  QMK MSYS will also throw an error if this is attempted.

* Update understanding_qmk.md

enclosed '&lt;' using backtick

* style guideline, now builds correctly

prior version indicates directory, new indicates config. still the same idea.</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* Indicate &lt;keyboard&gt;.h LAYOUT() deprecation in understanding_qmk.md

Initial documentation uses &lt;keyboard&gt;.json to define matrix pin definitions, rather than having users #define the LAYOUT() macro in &lt;keyboard&gt;.h  -  This change brings this docs inline with the [porting_guidelines](https://docs.qmk.fm/porting_your_keyboard_to_qmk),  QMK MSYS will also throw an error if this is attempted.

* Update understanding_qmk.md

enclosed '&lt;' using backtick

* style guideline, now builds correctly

prior version indicates directory, new indicates config. still the same idea.</pre>
</div>
</content>
</entry>
<entry>
<title>Vitepress conversion of docs. (#23795)</title>
<updated>2024-05-30T02:00:41+00:00</updated>
<author>
<name>Nick Brassel</name>
<email>nick@tzarc.org</email>
</author>
<published>2024-05-30T02:00:41+00:00</published>
<link rel='alternate' type='text/html' href='https://git.vineetk.net/qmk_firmware/commit/?id=6ef97172889ccd5db376b2a9f8825489e24fdac4'/>
<id>6ef97172889ccd5db376b2a9f8825489e24fdac4</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Move `pre_process_record_kb()` before `process_combo()` (#20969)</title>
<updated>2023-05-20T12:15:55+00:00</updated>
<author>
<name>Sergey Vlasov</name>
<email>sigprof@gmail.com</email>
</author>
<published>2023-05-20T12:15:55+00:00</published>
<link rel='alternate' type='text/html' href='https://git.vineetk.net/qmk_firmware/commit/?id=21b660fa07455a0173770ccab1cd21d7c7625014'/>
<id>21b660fa07455a0173770ccab1cd21d7c7625014</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Add a user callback for pre process record (#20584)</title>
<updated>2023-05-13T07:42:06+00:00</updated>
<author>
<name>Albert Y</name>
<email>76888457+filterpaper@users.noreply.github.com</email>
</author>
<published>2023-05-13T07:42:06+00:00</published>
<link rel='alternate' type='text/html' href='https://git.vineetk.net/qmk_firmware/commit/?id=128f808496cf7800fde3c7508388745bd99e8016'/>
<id>128f808496cf7800fde3c7508388745bd99e8016</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Update understanding_qmk.md (#19664)</title>
<updated>2023-01-24T15:17:24+00:00</updated>
<author>
<name>arrowj</name>
<email>172841+arrowj@users.noreply.github.com</email>
</author>
<published>2023-01-24T15:17:24+00:00</published>
<link rel='alternate' type='text/html' href='https://git.vineetk.net/qmk_firmware/commit/?id=419a7944a461c78e985cf975a5a4e6bacbbeebd2'/>
<id>419a7944a461c78e985cf975a5a4e6bacbbeebd2</id>
<content type='text'>
Changed "...4 row by 5 column numpad" to "...5 row by 4 column numpad" on line 46.</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Changed "...4 row by 5 column numpad" to "...5 row by 4 column numpad" on line 46.</pre>
</div>
</content>
</entry>
<entry>
<title>Remove thermal printer. (#18959)</title>
<updated>2022-11-05T13:15:55+00:00</updated>
<author>
<name>Nick Brassel</name>
<email>nick@tzarc.org</email>
</author>
<published>2022-11-05T13:15:55+00:00</published>
<link rel='alternate' type='text/html' href='https://git.vineetk.net/qmk_firmware/commit/?id=5233c69bc60aa612709e5d74a005431594612b6e'/>
<id>5233c69bc60aa612709e5d74a005431594612b6e</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>[Docs] Update 'Process Record' according to the code (#18209)</title>
<updated>2022-09-03T17:46:42+00:00</updated>
<author>
<name>coliss86</name>
<email>coliss86@users.noreply.github.com</email>
</author>
<published>2022-09-03T17:46:42+00:00</published>
<link rel='alternate' type='text/html' href='https://git.vineetk.net/qmk_firmware/commit/?id=39e611794d3ac5c0e56d4d7faaf28f930a221690'/>
<id>39e611794d3ac5c0e56d4d7faaf28f930a221690</id>
<content type='text'>
* [doc] Update 'Process Record' according to the code

* [doc] fix link</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* [doc] Update 'Process Record' according to the code

* [doc] fix link</pre>
</div>
</content>
</entry>
<entry>
<title>Removes terminal from QMK. (#17258)</title>
<updated>2022-05-31T05:38:08+00:00</updated>
<author>
<name>Nick Brassel</name>
<email>nick@tzarc.org</email>
</author>
<published>2022-05-31T05:38:08+00:00</published>
<link rel='alternate' type='text/html' href='https://git.vineetk.net/qmk_firmware/commit/?id=854547330704fb1b1f07d547d49728da8b92b2a3'/>
<id>854547330704fb1b1f07d547d49728da8b92b2a3</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>Some docs improvements (#15845)</title>
<updated>2022-03-05T04:58:50+00:00</updated>
<author>
<name>kiilerix</name>
<email>mads@kiilerich.com</email>
</author>
<published>2022-03-05T04:58:50+00:00</published>
<link rel='alternate' type='text/html' href='https://git.vineetk.net/qmk_firmware/commit/?id=da6d6ce2e1f266892badbd42fb8c6735e61e784f'/>
<id>da6d6ce2e1f266892badbd42fb8c6735e61e784f</id>
<content type='text'>
* docs: clarify in "Keymap Overview" what LAYOUT is and isn't

It is not strictly necessary to use LAYOUT macros in keyboard.c, but it
is a convenient abstraction of hardware internals, allowing focus on the
physical keyboard layout.

From the C source point of view LAYOUT is macro with a parameter list,
which expands to a array of rows that each is an array with a keyboard
scancode for each column. A macro parameter list is not an array, and
even less a single array.

Perhaps no big deal, but also no reason to give incorrect hints.

* docs: update "Understanding QMK's Code" to current code structure introduced in 96e2b13d1de

This part of the documentation was no longer correct. I tried updating
it, mainly copy editing and using github links to latest release.

This is not trying to fix all problems, but just trying to fix some
problems while reusing much of the old phrases and structure.

* Update docs to use "qmk format-python"</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* docs: clarify in "Keymap Overview" what LAYOUT is and isn't

It is not strictly necessary to use LAYOUT macros in keyboard.c, but it
is a convenient abstraction of hardware internals, allowing focus on the
physical keyboard layout.

From the C source point of view LAYOUT is macro with a parameter list,
which expands to a array of rows that each is an array with a keyboard
scancode for each column. A macro parameter list is not an array, and
even less a single array.

Perhaps no big deal, but also no reason to give incorrect hints.

* docs: update "Understanding QMK's Code" to current code structure introduced in 96e2b13d1de

This part of the documentation was no longer correct. I tried updating
it, mainly copy editing and using github links to latest release.

This is not trying to fix all problems, but just trying to fix some
problems while reusing much of the old phrases and structure.

* Update docs to use "qmk format-python"</pre>
</div>
</content>
</entry>
<entry>
<title>[Docs] Reorder functions in Understanding QMK (#15357)</title>
<updated>2021-11-30T19:24:21+00:00</updated>
<author>
<name>thesecretmaster</name>
<email>15304293+thesecretmaster@users.noreply.github.com</email>
</author>
<published>2021-11-30T19:24:21+00:00</published>
<link rel='alternate' type='text/html' href='https://git.vineetk.net/qmk_firmware/commit/?id=c2e0b283c302891e4aeba4584ed863bdfd52d692'/>
<id>c2e0b283c302891e4aeba4584ed863bdfd52d692</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
</feed>
