summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCem Aksoylar <caksoylar@users.noreply.github.com>2021-09-14 17:51:05 -0700
committerGitHub <noreply@github.com>2021-09-14 20:51:05 -0400
commit33fa15a235ec731db976d8c1eb6342d6d0f84581 (patch)
tree556a75b5b697afb4c3c01423fe9decf2dc28f2f2
parentc9a671d8d5f6144771e3835322ce421012c39375 (diff)
feat(docs): Add note to clarify shared .conf files do not apply outside zmk-config
-rw-r--r--docs/docs/development/new-shield.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/docs/development/new-shield.md b/docs/docs/development/new-shield.md
index 83b1fc6..6e17336 100644
--- a/docs/docs/development/new-shield.md
+++ b/docs/docs/development/new-shield.md
@@ -286,6 +286,10 @@ In most case you'll only need to use the .conf file that affects both halves of
CONFIG_ZMK_SLEEP=y
```
+:::note
+The shared configuration in `my_awesome_split_board.conf` is only applied when you are building with a [`zmk-config` folder](build-flash#building-from-zmk-config-folder) and when it is present at `config/my_awesome_split_board.conf`. If you are not using a `zmk-config` folder, you will need to include the shared configuration in both `my_awesome_split_board_left.conf` and `my_awesome_split_board_right.conf` files.
+:::
+
</TabItem>
</Tabs>