From 9d234cbb10aafcaa65eb1c53296d0f13f3b804fb Mon Sep 17 00:00:00 2001 From: Cem Aksoylar Date: Mon, 17 Feb 2025 11:55:42 -0800 Subject: [PATCH] docs: Make default keymap in new shield guide complete (#2825) Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com> --- docs/docs/development/hardware-integration/new-shield.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/docs/development/hardware-integration/new-shield.mdx b/docs/docs/development/hardware-integration/new-shield.mdx index 1430be744..6ef60c3dd 100644 --- a/docs/docs/development/hardware-integration/new-shield.mdx +++ b/docs/docs/development/hardware-integration/new-shield.mdx @@ -489,11 +489,13 @@ If all of your physical layouts use the same `kscan` node under the hood, you ca Each keyboard should provide a default keymap to be used when building the firmware, which can be overridden and customized by user configs. For "shield keyboards", this should be placed in the `boards/shields/my_keyboard/my_keyboard.keymap` file. -The keymap is configured as an additional devicetree overlay that includes the following: Here is an example simple keymap for a 3x3 macropad, with only one layer: ```dts title="my_keyboard.keymap" +#include +#include + / { keymap { compatible = "zmk,keymap";