drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

[docs] Organize driver & feature docs into subfolders (#23848)

Browse source 
Co-authored-by: Nick Brassel <nick@tzarc.org>
This commit is contained in:
Ryan 2024-06-02 12:42:24 +10:00 • committed by GitHub
parent fa6d23235b
commit 78a0adfbb4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
97 changed files with 282 additions and 285 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/hardware_keyboard_guidelines.md
View file

@ -230,7 +230,7 @@ Given the amount of functionality that QMK exposes it's very easy to confuse new
### Magic Keycodes and Command
[Magic Keycodes](keycodes_magic) and [Command](feature_command) are two related features that allow a user to control their keyboard in non-obvious ways. We recommend you think long and hard about if you're going to enable either feature, and how you will expose this functionality. Keep in mind that users who want this functionality can enable it in their personal keymaps without affecting all the novice users who may be using your keyboard as their first programmable board.
[Magic Keycodes](keycodes_magic) and [Command](features/command) are two related features that allow a user to control their keyboard in non-obvious ways. We recommend you think long and hard about if you're going to enable either feature, and how you will expose this functionality. Keep in mind that users who want this functionality can enable it in their personal keymaps without affecting all the novice users who may be using your keyboard as their first programmable board.
By far the most common problem new users encounter is accidentally triggering Bootmagic while they're plugging in their keyboard. They're holding the keyboard by the bottom, unknowingly pressing in alt and spacebar, and then they find that these keys have been swapped on them. We recommend leaving this feature disabled by default, but if you do turn it on consider setting `BOOTMAGIC_KEY_SALT` to a key that is hard to press while plugging your keyboard in.