diff options
| author | Chiyuan Zhang <pluskid@gmail.com> | 2020-11-02 20:17:56 -0800 |
|---|---|---|
| committer | Pete Johanson <peter@peterjohanson.com> | 2020-11-02 23:30:03 -0500 |
| commit | a9e729b427800fab230fc1fcdacd3cbdb6bedc19 (patch) | |
| tree | a2dc82ae1bbffcf86b0a7c3ccbac1cd8c6cf20a3 | |
| parent | 9b941b7509b99539a133da14fc33a7cdb7853533 (diff) | |
make note about keyboard name more explicit
| -rw-r--r-- | docs/docs/dev-guide-new-shield.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/docs/dev-guide-new-shield.md b/docs/docs/dev-guide-new-shield.md index fd407b7..7a0a248 100644 --- a/docs/docs/dev-guide-new-shield.md +++ b/docs/docs/dev-guide-new-shield.md @@ -75,7 +75,11 @@ that make sense to have different defaults when this shield is used. One main it that usually has a new default value set here is the `ZMK_KEYBOARD_NAME` value, which controls the display name of the device over USB and BLE. -The updated new default values should always be wrapped inside a conditional on the shield config name defined in the `Kconfig.shield` file. Here's the simplest example file. Note: do not make the keyboard name too long, otherwise the bluetooth advertising might fail and you will not be able to find your keyboard from your laptop / tablet. +The updated new default values should always be wrapped inside a conditional on the shield config name defined in the `Kconfig.shield` file. Here's the simplest example file. + +:::warning +Do not make the keyboard name too long, otherwise the bluetooth advertising might fail and you will not be able to find your keyboard from your laptop / tablet. +::: ``` if SHIELD_MY_BOARD |