kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Apply suggestions from code review

Browse source 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
This commit is contained in:
Nicolas Munnich 2024-07-24 09:42:22 +02:00 • committed by GitHub
parent 41723d18c9
commit da70472e82
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/docs/config/index.md
View file

@ -35,7 +35,7 @@ ZMK will search for config files in:
- `<module>/boards/arm/<board>`
- `zmk-config/config/boards/arm/<board>` (For backwards compatibility only, do not use.)
...where `<board>` is the name of the board and `<module>` is the root directory of any [included module](#../features/modules.mdx). These files describe the hardware of the board.
...where `<board>` is the name of the board and `<module>` is the root directory of any [included module](../features/modules.mdx). These files describe the hardware of the board.
ZMK will search the board folder for the following config files:
@ -57,7 +57,7 @@ When building with a shield, ZMK will search for config files in:
- `<module>/boards/shields/<shield>`
- `zmk-config/config/boards/shields/<shield>` (For backwards compatibility only, do not use.)
...where `<shield>` is the name of the shield and `<module>` is the root directory of any [included module](#../features/modules.mdx). These files describe the hardware of the shield that the board is plugged into.
...where `<shield>` is the name of the shield and `<module>` is the root directory of any [included module](../features/modules.mdx). These files describe the hardware of the shield that the board is plugged into.
ZMK will search the shield folder for the following config files:

4
docs/docs/features/modules.mdx
View file

@ -9,9 +9,9 @@ import TabItem from "@theme/TabItem";
ZMK makes use of [Zephyr modules](https://docs.zephyrproject.org/3.5.0/develop/modules.html) to include additional source code or configuration files into its build. You can think of them as similar to plugins or themes. The most common uses of this feature are:
- Building firmware for a keyboard external to ZMK's tree
- Adding functionality to ZMK, such as a driver or a behaviour
- Adding functionality to ZMK, such as a driver or a behavior
A common ZMK setup thus consists of the following separate Git repositories:
A common ZMK setup thus consists of the following separate components, commonly housed in their respective Git repositories:
- A single ZMK config maintained by the user, containing the `.conf` and `.keymap` files for one or multiple keyboards. This is also where files from ZMK or modules should be overridden/modified, if there is a need.
- Any number of ZMK modules, maintained by the module's owner. Some modules may contain multiple keyboards or functionalities. If all of your keyboards and functionalities are internal to ZMK's tree, then no modules are necessary.