Skip to content

Commit

Permalink
Added a page on ZMK modules and modified some other files around that…
Browse files Browse the repository at this point in the history
… topic, along with minor changes to sidebars.js to make the sidebar nicer.
  • Loading branch information
Nick-Munnich committed Jul 18, 2024
1 parent 95890e9 commit 41723d1
Show file tree
Hide file tree
Showing 5 changed files with 210 additions and 232 deletions.
16 changes: 10 additions & 6 deletions docs/docs/config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,14 @@ When using a split keyboard, you can use a single file without the `_left` or `_

### Board Folder

ZMK will search for config files in either of:
ZMK will search for config files in:

- [`zmk/app/boards/arm/<board>`](https://github.com/zmkfirmware/zmk/tree/main/app/boards/arm)
- `zmk-config/config/boards/arm/<board>`
- `zmk-config/boards/arm/<board>`
- `<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. 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:

Expand All @@ -48,12 +50,14 @@ For more documentation on creating and configuring a new board, see [Zephyr's bo

### Shield Folder

When building with a shield, ZMK will search for config files in either of:
When building with a shield, ZMK will search for config files in:

- [`zmk/app/boards/shields/<shield>`](https://github.com/zmkfirmware/zmk/tree/main/app/boards/shields)
- `zmk-config/config/boards/shields/<shield>`
- `zmk-config/boards/shields/<shield>`
- `<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. 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:

Expand Down
7 changes: 7 additions & 0 deletions docs/docs/development/new-shield.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,13 @@ Follow these steps to create your new repository:
- Select Public or Private, depending on your preference.
- Click the green "Create repository" button

The repository is a combination of the directories and files required of a ZMK config, and those required of a shield module. To create a shield module, the following components are needed:

- The `boards/shields` directory, where the keyboard's files will go
- The `zephyr/module.yml` file, which identifies and describes the module. See the [Zephyr documentation](https://docs.zephyrproject.org/3.5.0/develop/modules.html#module-yaml-file-description) for details on customising this file. For the purposes of creating a shield module, the default found in the template can be left untouched.

Neither of these should be moved out of their parent directory. The other files and directories are unnecessary for the purposes of a shield module.

## New Shield Directory

:::note
Expand Down
100 changes: 0 additions & 100 deletions docs/docs/features/beta-testing.mdx

This file was deleted.

59 changes: 48 additions & 11 deletions docs/docs/features/modules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ title: Modules
sidebar_label: Modules
---

ZMK makes use of [Zephyr modules]() to include additional source code or configuration files into its build. The most common uses of this feature are:
import Tabs from "@theme/Tabs";
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
Expand All @@ -14,18 +17,21 @@ A common ZMK setup thus consists of the following separate Git repositories:
- 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.
- The ZMK firmware itself, maintained by its contributors.

Further information on creating modules for ZMK and ZMK's overall file structure can be found [in the corresponding section]().

:::note
The shift to using modules for keyboards is a relatively recent one, and not all designs may be properly configured to be used as a module. If this is the case for your keyboard, then we would strongly suggest asking your vendor or designer to rectify this.
:::

## Building With Modules

Adding modules to your ZMK build is as simple as modifying the `west.yml` found in your `zmk-config`'s `config` directory. You will need to:
1. Find and add the URL base for the module.
Adding modules to your ZMK build is as simple as modifying the `west.yml` found in your `zmk-config`'s `config` directory. The recommended way of doing so is:

1. Find the URL base (the parent URL) for the module and add it as an entry to the [remotes](https://docs.zephyrproject.org/3.5.0/develop/west/manifest.html#remotes).
2. Add the module as an entry to the [projects](https://docs.zephyrproject.org/3.5.0/develop/west/manifest.html#projects).
Aside from the mandatory `name`, `remote`, and the commonly used `revision` properties, take note of the `import` property under `projects`. Some modules may have other modules as dependencies. This property allows the specifying of an additional west manifest file found in the tree of the module, which will automatically import all dependencies.

For more information on `west.yml`, see [West Manifests](https://docs.zephyrproject.org/3.5.0/develop/west/manifest.html).

### Example
### Examples

<Tabs
defaultValue="zmk"
Expand All @@ -51,20 +57,51 @@ manifest:
```
</TabItem>
<TabItem value="alt">
<TabItem value="ma">
```yaml
manifest:
remotes:
- name: zmkfirmware
url-base: https://github.com/zmkfirmware
- name: forkedzmk
url-base: https://github.com/forkedzmk
- name: module_a_base
url-base: https://github.com/alice
projects:
- name: zmk
remote: forkedzmk
revision: specificpr
remote: zmkfirmware
revision: main
import: app/west.yml
- name: module_a
remote: module_a_base
revision: main
self:
path: config
```
</TabItem>
<TabItem value="mab">
```yaml
manifest:
remotes:
- name: zmkfirmware
url-base: https://github.com/zmkfirmware
- name: module_a_base
url-base: https://github.com/alice
- name: module_b_base
url-base: https://github.com/bob
projects:
- name: zmk
remote: zmkfirmware
revision: main
import: app/west.yml
- name: module_a
remote: module_a_base
revision: main
- name: module_b
remote: module_b_base
revision: main
import: west.yml
self:
path: config
```
Expand Down
Loading

0 comments on commit 41723d1

Please sign in to comment.