mirror of
https://github.com/zmkfirmware/zmk.git
synced 2026-03-21 13:35:17 -05:00
fix(docs): Standardize all internal links
This commit is contained in:
committed by
Pete Johanson
parent
689ba2d171
commit
d964faaa89
@@ -11,7 +11,7 @@ The foundational elements needed to get a specific keyboard working with ZMK can
|
||||
- A keymap, which binds each key position to a behavior, e.g. key press, mod-tap, momentary layer, in a set of layers.
|
||||
|
||||
These three core architectural elements are defined per-keyboard, and _where_ they are defined depends on the specifics of how that
|
||||
keyboard works. For an overview on the general concepts of boards and shields, please see the [FAQs on boards and shields](/docs/faq#why-boards-and-shields--why-not-just-keyboard).
|
||||
keyboard works. For an overview on the general concepts of boards and shields, please see the [FAQs on boards and shields](../faq.md#why-boards-and-shields--why-not-just-keyboard).
|
||||
|
||||
## Self-Contained Keyboard
|
||||
|
||||
|
||||
@@ -90,7 +90,7 @@ This produces `left` and `right` subfolders under the `build` directory and two
|
||||
|
||||
### Building from `zmk-config` Folder
|
||||
|
||||
Instead of building .uf2 files using the default keymap and config files, you can build directly from your [`zmk-config` folder](../user-setup#github-repo) by adding
|
||||
Instead of building .uf2 files using the default keymap and config files, you can build directly from your [`zmk-config` folder](../user-setup.md#github-repo) by adding
|
||||
`-DZMK_CONFIG="C:/the/absolute/path/config"` to your `west build` command. **Notice that this path should point to the folder labelled `config` within your `zmk-config` folder.**
|
||||
|
||||
For instance, building kyria firmware from a user `myUser`'s `zmk-config` folder on Windows 10 may look something like this:
|
||||
@@ -107,7 +107,7 @@ volume automatically -- we need to delete the default volume before binding it t
|
||||
1. Remove all the containers that are not running via the command `docker container prune`. We need to remove the ZMK container before we can delete the default `zmk-config` volume referenced by it. If you do not want to delete all the containers that are not running, you can find the id of the ZMK container and use `docker rm` to delete that one only.
|
||||
1. Remove the default volume via the command `docker volume rm zmk-config`.
|
||||
|
||||
Then you can bind the `zmk-config` volume to the correct path pointing to your local [zmk-config](./customization.md) folder:
|
||||
Then you can bind the `zmk-config` volume to the correct path pointing to your local [zmk-config](customization.md) folder:
|
||||
|
||||
```
|
||||
docker volume create --driver local -o o=bind -o type=none -o \
|
||||
|
||||
@@ -35,7 +35,7 @@ terminal to the ZMK repository and run the following command:
|
||||
west config build.cmake-args -- -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
|
||||
```
|
||||
|
||||
Every [build](build-flash#building) will now update the database. You will
|
||||
Every [build](build-flash.md#building) will now update the database. You will
|
||||
need to build once to create the database before code completion will work.
|
||||
We'll tell Visual Studio Code where to find the database in the next step.
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ ZMK support for split keyboards requires a few more files than single boards to
|
||||
:::note
|
||||
This guide describes how to add shield to the ZMK main repository. If you are building firmware for your
|
||||
own prototype or handwired keyboard, it is recommended to use your own user config repository. Follow the
|
||||
[user setup guide](./user-setup.md) to create your user config repository first. When following the rest
|
||||
[user setup guide](user-setup.md) to create your user config repository first. When following the rest
|
||||
of this guide, replace the `app/` directory in the ZMK main repository with the `config/` directory in your
|
||||
user config repository. For example, `app/boards/shields/<keyboard_name>` should now be
|
||||
`config/boards/shields/<keyboard_name>`.
|
||||
@@ -449,7 +449,7 @@ Add the following line to your keymap file to add default encoder behavior bindi
|
||||
sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN>;
|
||||
```
|
||||
|
||||
Add additional bindings as necessary to match the default number of encoders on your board. See the [Encoders](/docs/features/encoders) and [Keymap](/docs/features/keymaps) feature documentation for more details.
|
||||
Add additional bindings as necessary to match the default number of encoders on your board. See the [Encoders](../features/encoders.md) and [Keymap](../features/keymaps.md) feature documentation for more details.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
@@ -477,11 +477,11 @@ west flash
|
||||
```
|
||||
|
||||
Please have a look at documentation specific to
|
||||
[building and flashing](build-flash) for additional information.
|
||||
[building and flashing](build-flash.md) for additional information.
|
||||
|
||||
:::note
|
||||
Further testing your keyboard shield without altering the root keymap file can be done with the use of `-DZMK_CONFIG` in your `west build` command,
|
||||
shown [here](build-flash#building-from-zmk-config-folder)
|
||||
shown [here](build-flash.md#building-from-zmk-config-folder)
|
||||
:::
|
||||
|
||||
## Updating `build.yml`
|
||||
|
||||
@@ -456,7 +456,7 @@ This step pulls down quite a bit of tooling. Go grab a cup of coffee, it can tak
|
||||
:::info
|
||||
If you're using Docker, you're done with setup! You must restart the container at this point. The easiest way to do so is to close the VS Code window, verify that the container has stopped in Docker Dashboard, and reopen the container with VS Code.
|
||||
|
||||
Once your container is restarted, proceed to [Building and Flashing](./development/build-flash.md).
|
||||
Once your container is restarted, proceed to [Building and Flashing](development/build-flash.md).
|
||||
:::
|
||||
|
||||
#### Export Zephyr™ Core
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Tests
|
||||
sidebar_label: Tests
|
||||
---
|
||||
|
||||
Running tests requires [native posix support](posix-board). Any folder under `/app/tests`
|
||||
Running tests requires [native posix support](posix-board.md). Any folder under `/app/tests`
|
||||
containing `native_posix.keymap` will be selected when running `west test`.
|
||||
|
||||
Run a single test with `west test <testname>`, like `west test tests/toggle-layer/normal`.
|
||||
|
||||
@@ -24,7 +24,7 @@ The `CONFIG_ZMK_USB_LOGGING` KConfig value needs to be set, either by copy and p
|
||||
`west build -t menuconfig` and manually enabling the setting in that UI at `ZMK -> Advanced -> USB Logging`.
|
||||
|
||||
:::note
|
||||
If you are debugging your own keyboard in your [user config repository](./user-setup.md), use
|
||||
If you are debugging your own keyboard in your [user config repository](user-setup.md), use
|
||||
`config/boards/shields/<your_keyboard>/<your_keyboard>.conf` instead of `app/prj.conf`. In Github
|
||||
Actions, you can search the `Kconfig file` build log to verify the options above have been enabled
|
||||
for you successfully.
|
||||
|
||||
Reference in New Issue
Block a user