search

qmk / qmk_firmware

Open-source keyboard firmware for Atmel AVR and Arm USB families
https://qmk.fm
GNU General Public License v2.0
18.09k stars 38.89k forks source link

[Docs] Linked example in keymaps docs is obsolete #18445

Closed weslord closed 1 year ago

weslord commented 2 years ago

The example keymap.c linked to in the keymap docs is pretty old (2017): https://github.com/qmk/qmk_firmware/blob/ee22f34e69abcd191b887d8dec7ae25655cc6cb4/docs/keymap.md?plain=1#L93

It includes an obsolete way of defining custom functions, a local define to alias _______ to KC_TRNS, uses KEYMAP() instead of LAYOUT(), and doesn't really match the inline examples in the markdown doc anymore.

I'd suggest updating it to https://github.com/qmk/qmk_firmware/blob/ee22f34e69abcd191b887d8dec7ae25655cc6cb4/keyboards/clueboard/66/keymaps/default/keymap.c, but I'm not personally familiar enough with the project to catch any new inconsistencies that might cause.

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had activity in the last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity occurs. For maintainers: Please label with bug, in progress, on hold, discussion or to do to prevent the issue from being re-flagged.

github-actions[bot] commented 1 year ago

This issue has been automatically closed because it has not had activity in the last 30 days. If this issue is still valid, re-open the issue and let us know. // [stale-action-closed]