diff --git a/docs/docs/customization.md b/docs/docs/customization.md index d0d37491..626a291b 100644 --- a/docs/docs/customization.md +++ b/docs/docs/customization.md @@ -39,7 +39,7 @@ If you need to, a review of [Learn The Basics Of Git In Under 10 Minutes](https: ## Building from a local `zmk` fork using `zmk-config` -[As outlined here](dev-build-flash), firmware comes in the form of .uf2 files, which can be built locally using the command `west build`. Normally, +[As outlined here](development/build-flash), firmware comes in the form of .uf2 files, which can be built locally using the command `west build`. Normally, `west build` will default to using the in-tree .keymap and .conf files found in your local copy of the `zmk` repository. However, you can append the command, `-DZMK_CONFIG="C:/the/absolute/path/config"` to `west build` in order to use the contents of your `zmk-config` folder instead of the default keyboard settings. **Notice that this path should point to the folder labelled `config` within your `zmk-config` folder.** diff --git a/docs/docs/dev-boards-shields-keymaps.md b/docs/docs/development/boards-shields-keymaps.md similarity index 98% rename from docs/docs/dev-boards-shields-keymaps.md rename to docs/docs/development/boards-shields-keymaps.md index 119db420..e78f5d38 100644 --- a/docs/docs/dev-boards-shields-keymaps.md +++ b/docs/docs/development/boards-shields-keymaps.md @@ -34,7 +34,7 @@ in the `app/boards/${arch}/${board_name}` directory, e.g. `app/boards/arm/planck ## Pro Micro Compatible Keyboard -![Labelled Pro Micro pins](assets/pro-micro/pro-micro-pins-labelled.jpg) +![Labelled Pro Micro pins](../assets/pro-micro/pro-micro-pins-labelled.jpg) For keyboards that require a (usually Pro Micro compatible) add-on board to operate, the ZMK integration pieces are places in the _shield_ definition for that keyboard, allowing users to diff --git a/docs/docs/dev-build-flash.md b/docs/docs/development/build-flash.md similarity index 99% rename from docs/docs/dev-build-flash.md rename to docs/docs/development/build-flash.md index 304ea323..e270a7c6 100644 --- a/docs/docs/dev-build-flash.md +++ b/docs/docs/development/build-flash.md @@ -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#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: diff --git a/docs/docs/dev-clean-room.md b/docs/docs/development/clean-room.md similarity index 100% rename from docs/docs/dev-clean-room.md rename to docs/docs/development/clean-room.md diff --git a/docs/docs/dev-guide-new-shield.md b/docs/docs/development/guide-new-shield.md similarity index 99% rename from docs/docs/dev-guide-new-shield.md rename to docs/docs/development/guide-new-shield.md index 0e8f9f00..306f1b3f 100644 --- a/docs/docs/dev-guide-new-shield.md +++ b/docs/docs/development/guide-new-shield.md @@ -4,7 +4,7 @@ title: New Keyboard Shield import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import KeymapExampleFile from './keymap-example-file.md'; +import KeymapExampleFile from '../keymap-example-file.md'; ## Overview @@ -110,7 +110,7 @@ endif ## Shield Overlays -![Labelled Pro Micro pins](assets/pro-micro/pro-micro-pins-labelled.jpg) +![Labelled Pro Micro pins](../assets/pro-micro/pro-micro-pins-labelled.jpg) ZMK uses the green color coded pin names to generate devicetree node references. For example, to refer to the node `D0` in the devicetree files, use `&pro_micro_d 0` or to refer to `A1`, use `&pro_micro_a 1`. @@ -474,7 +474,7 @@ west flash :::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](dev-build-flash#building-from-zmk-config-folder) +shown [here](build-flash#building-from-zmk-config-folder) ::: ## Updating `build.yml` diff --git a/docs/docs/dev-guide-usb-logging.md b/docs/docs/development/guide-usb-logging.md similarity index 96% rename from docs/docs/dev-guide-usb-logging.md rename to docs/docs/development/guide-usb-logging.md index 3dc62e36..6e4e2bef 100644 --- a/docs/docs/dev-guide-usb-logging.md +++ b/docs/docs/development/guide-usb-logging.md @@ -80,9 +80,9 @@ sudo tio /dev/ttyACM0 On Windows, you can use [PuTTY](https://www.putty.org/). Once installed, use Device Manager to figure out which COM port your controller is communicating on (listed under 'Ports (COM & LPT)') and specify that as the 'Serial line' in PuTTY. -![Controller COM port](./assets/usb-logging/com.jpg) +![Controller COM port](../assets/usb-logging/com.jpg) -![PuTTY settings](assets/usb-logging/putty.jpg) +![PuTTY settings](../assets/usb-logging/putty.jpg) If you already have the Ardunio IDE installed you can also use its built-in Serial Monitor. diff --git a/docs/docs/dev-posix-board.md b/docs/docs/development/posix-board.md similarity index 100% rename from docs/docs/dev-posix-board.md rename to docs/docs/development/posix-board.md diff --git a/docs/docs/dev-setup.md b/docs/docs/development/setup.md similarity index 96% rename from docs/docs/dev-setup.md rename to docs/docs/development/setup.md index 864574a4..441299a9 100644 --- a/docs/docs/dev-setup.md +++ b/docs/docs/development/setup.md @@ -411,7 +411,7 @@ cd zmk Open the `zmk` checkout folder in VS Code. The repository includes a configuration for containerized development, so an alert will pop up: -![VS Code Dev Container Configuration Alert](assets/dev-setup/vscode_devcontainer.png) +![VS Code Dev Container Configuration Alert](../assets/dev-setup/vscode_devcontainer.png) Click `Reopen in Container` in order to reopen the VS Code with the running container. @@ -449,7 +449,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](./dev-build-flash.md). +Once your container is restarted, proceed to [Building and Flashing](./development/build-flash.md). ::: #### Export Zephyr™ Core @@ -480,23 +480,23 @@ On Windows, only two environment variables need to be set for ZMK to build prope 1. Open Start Menu and type 'env' to find the 'Edit the system environment variables' option. Open it. -![Environment variables in Start Menu](assets/env-var/start_menu.png) +![Environment variables in Start Menu](../assets/env-var/start_menu.png) 2. Click 'Environment Variables...'. -![Environment variables button](assets/env-var/env_var.png) +![Environment variables button](../assets/env-var/env_var.png) 3. Click "New..." under System variables to create a new system variable. -![Environment variables menu](assets/env-var/new_variable.png) +![Environment variables menu](../assets/env-var/new_variable.png) 4. Set the variable name to 'ZEPHYR_TOOLCHAIN_VARIANT' and value to 'gnuarmemb'. Click OK to save. -![Adding Zephyr toolchain variable](assets/env-var/zephyr_toolchain.png) +![Adding Zephyr toolchain variable](../assets/env-var/zephyr_toolchain.png) 5. Create another variable with variable name 'GNUARMEMB_TOOLCHAIN_PATH' and value set to wherever you installed your toolchain. **Make sure this path does not contain any spaces.** If it does, rename the folder and update here. Click OK to save. -![Adding GNUARMEMB variable](assets/env-var/gnuarmemb.png) +![Adding GNUARMEMB variable](../assets/env-var/gnuarmemb.png) 6. Close Command Prompt and reopen, or run `refreshenv` to apply the changes. diff --git a/docs/docs/dev-tests.md b/docs/docs/development/tests.md similarity index 90% rename from docs/docs/dev-tests.md rename to docs/docs/development/tests.md index 98381d7f..8df6cb17 100644 --- a/docs/docs/dev-tests.md +++ b/docs/docs/development/tests.md @@ -3,7 +3,7 @@ title: Tests sidebar_label: Tests --- -Running tests requires [native posix support](./dev-posix-board). Any folder under `/app/tests` +Running tests requires [native posix support](posix-board). Any folder under `/app/tests` containing `native_posix.keymap` will be selected when running `./run-test.sh all`. ## Creating a New Test Set diff --git a/docs/docs/features/encoders.md b/docs/docs/features/encoders.md index 52a4357e..f962845b 100644 --- a/docs/docs/features/encoders.md +++ b/docs/docs/features/encoders.md @@ -41,4 +41,4 @@ Here, the left encoder is configured to control volume up and down while the rig ## Adding Encoder Support -See the [New Keyboard Shield](/docs/dev-guide-new-shield#encoders) documentation for how to add or modify additional encoders to your shield. +See the [New Keyboard Shield](../development/guide-new-shield#encoders) documentation for how to add or modify additional encoders to your shield. diff --git a/docs/docs/hardware.md b/docs/docs/hardware.md index 46e9f88f..2ad6c337 100644 --- a/docs/docs/hardware.md +++ b/docs/docs/hardware.md @@ -47,4 +47,4 @@ Until detailed documentation is available, feel free to ask questions about how ## Contributing -If you'd like to add support for a new keyboard shield, head over to the [New Keyboard Shield](/docs/dev-guide-new-shield) documentation. +If you'd like to add support for a new keyboard shield, head over to the [New Keyboard Shield](development/guide-new-shield) documentation. diff --git a/docs/docs/troubleshooting.md b/docs/docs/troubleshooting.md index 7f7d9941..0fe0b665 100644 --- a/docs/docs/troubleshooting.md +++ b/docs/docs/troubleshooting.md @@ -26,7 +26,7 @@ Variations of the warnings shown below occur when flashing the `.uf2` ### CMake Error An error along the lines of `CMake Error at (zmk directory)/zephyr/cmake/generic_toolchain.cmake:64 (include): include could not find load file:` during firmware compilation indicates that the Zephyr Environment Variables are not properly defined. -For more information, click [here](../docs/dev-setup#environment-variables). +For more information, click [here](../docs/development/setup#environment-variables). ### dtlib.DTError diff --git a/docs/docs/user-setup.md b/docs/docs/user-setup.md index d1552868..50074adb 100644 --- a/docs/docs/user-setup.md +++ b/docs/docs/user-setup.md @@ -105,7 +105,7 @@ Pick an MCU board: :::note If you are building firmware for a new keyboard shield that is not included in the built-in list of shields, you can choose any shield from the list that is similar to yours to generate the repository, -and edit / add necessary files according to the [guide for adding new keyboard shield](./dev-guide-new-shield.md). +and edit / add necessary files according to the [guide for adding new keyboard shield](./development/guide-new-shield). ::: When prompted, enter the number for the corresponding keyboard shield you would like to target: diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 97548342..2716039c 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -45,7 +45,7 @@ module.exports = { }, { label: "Development", - to: "docs/dev-setup/", + to: "docs/development/setup/", }, ], }, diff --git a/docs/sidebars.js b/docs/sidebars.js index 59cfb1ec..3e4d2e4a 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -37,13 +37,16 @@ module.exports = { "codes/power", ], Development: [ - "dev-clean-room", - "dev-setup", - "dev-build-flash", - "dev-boards-shields-keymaps", - "dev-posix-board", - "dev-tests", + "development/clean-room", + "development/setup", + "development/build-flash", + "development/boards-shields-keymaps", + "development/posix-board", + "development/tests", + ], + "Dev Guides": [ + "development/guide-new-shield", + "development/guide-usb-logging", ], - "Dev Guides": ["dev-guide-new-shield", "dev-guide-usb-logging"], }, };