docs: Better document the layer display-name prop.

petejohanson · Oct 16, 2024 · d6be903 · d6be903
1 parent 0adb80c
commit d6be903
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/docs/docs/config/keymap.md b/docs/docs/config/keymap.md
@@ -19,7 +19,7 @@ Each child node can have the following properties:
 
 | Property          | Type          | Description                                                          |
 | ----------------- | ------------- | -------------------------------------------------------------------- |
-| `display-name`    | string        | Name for the layer on displays                                       |
+| `display-name`    | string        | Name for the layer in ZMK Studio and on displays                     |
 | `bindings`        | phandle-array | List of [key behaviors](../keymaps/index.mdx#behaviors), one per key |
 | `sensor-bindings` | phandle-array | List of sensor behaviors, one per sensor                             |
 

diff --git a/docs/docs/keymap-example.md b/docs/docs/keymap-example.md
@@ -3,6 +3,7 @@
         compatible = "zmk,keymap";
 
         default_layer { // Layer 0
+            display-name = "Base";
 // ----------------------------------------------
 // |      Z      |        M       |      K      |
 // |    &mo 1    |   LEFT SHIFT   |    &mo 2    |
@@ -12,6 +13,7 @@
             >;
         };
         abc { // Layer 1
+            display-name = "ABC";
 // ----------------------------------------------
 // |      A      |       B       |       C      |
 // |    &trans   |    &trans     |     &trans   |
@@ -21,6 +23,7 @@
             >;
         };
         xyz { // Layer 2
+            display-name = "XYZ";
 // ----------------------------------------------
 // |        X       |      Y       |      Z     |
 // |   LEFT CTRL    |  LEFT ALT    |   &trans   |