diff --git a/docs/docs/assets/features/under-development/pr-repo-branch.png b/docs/docs/assets/features/under-development/pr-repo-branch.png new file mode 100644 index 00000000..68856d0b Binary files /dev/null and b/docs/docs/assets/features/under-development/pr-repo-branch.png differ diff --git a/docs/docs/assets/features/under-development/repo-branch.png b/docs/docs/assets/features/under-development/repo-branch.png new file mode 100644 index 00000000..741e69a4 Binary files /dev/null and b/docs/docs/assets/features/under-development/repo-branch.png differ diff --git a/docs/docs/assets/features/under-development/repo-url.png b/docs/docs/assets/features/under-development/repo-url.png new file mode 100644 index 00000000..aed37137 Binary files /dev/null and b/docs/docs/assets/features/under-development/repo-url.png differ diff --git a/docs/docs/customization.md b/docs/docs/customization.md index 40c64ea1..626a291b 100644 --- a/docs/docs/customization.md +++ b/docs/docs/customization.md @@ -3,9 +3,6 @@ title: Customizing ZMK/`zmk-config` folders sidebar_label: Customizing ZMK --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - After verifying you can successfully flash the default firmware, you will probably want to begin customizing your keymap and other keyboard options. [In the initial setup tutorial](user-setup), you created a Github repository called `zmk-config`. This repository is a discrete filesystem which works with the main `zmk` firmware repository to build your desired firmware. The main advantage of a discrete configuration folder is ensuring that the @@ -31,75 +28,6 @@ various config settings that can be commented/uncommented to modify how your fir Once you have the basic user config completed, you can find the keymap file in `config/.keymap` and customize from there. Refer to the [Keymap](/docs/features/keymaps) documentation to learn more. -## Testing features - -Testing features will require you to modify the `west.yml` file. You will need to add a new remote for the pull request you would like to test, -and change the selected remote and revision for the `zmk` project. - - - - -``` -manifest: - remotes: - - name: zmkfirmware - url-base: https://github.com/zmkfirmware - projects: - - name: zmk - remote: zmkfirmware - revision: main - import: app/west.yml - self: - path: config -``` - - - - -``` -manifest: - remotes: - - name: zmkfirmware - url-base: https://github.com/zmkfirmware - - name: okke-formsma - url-base: https://github.com/okke-formsma - projects: - - name: zmk - remote: okke-formsma - revision: macros - import: app/west.yml - self: - path: config -``` - - - - -``` -manifest: - remotes: - - name: zmkfirmware - url-base: https://github.com/zmkfirmware - - name: mcrosson - url-base: https://github.com/mcrosson - projects: - - name: zmk - remote: mcrosson - revision: feat-behavior-sleep - import: app/west.yml - self: - path: config -``` - - - - ## Publishing After making any changes you want, you should commit the changes and then push them to GitHub. That will trigger a new diff --git a/docs/docs/features/under-development.md b/docs/docs/features/under-development.md new file mode 100644 index 00000000..486ea5d9 --- /dev/null +++ b/docs/docs/features/under-development.md @@ -0,0 +1,100 @@ +--- +title: Under Development +sidebar_label: Under Development +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +You may find that ZMK does not support a feature or keyboard that you are interesting in using. You may find that someone +has already taken the time to submit the feature you need as a [Pull Request](https://github.com/zmkfirmware/zmk/pulls). If you find the feature you need as a pull request, +this page is for you! + +## Developer Repositories and Branches + +For a developer to submit a pull request to ZMK, they must first clone the original ZMK repository. After they have a copy +of the source code, they may create a feature branch to work within. When they have finished, they will publish the feature +branch and create the pull request. + +### Finding the Repository Page from the Pull Request + +![PR Repository](../assets/features/under-development/pr-repo-branch.png) + +### Finding the Repository URL + +![Repository URL](../assets/features/under-development/repo-url.png) + +### Finding the Repository Branch + +![Repository URL](../assets/features/under-development/repo-branch.png) + +## Testing features + +Testing features will require you to modify the `west.yml` file. You will need to add a new remote for the pull request you +would like to test, and change the selected remote (or repository) and revision (or branch) for the `zmk` project. + +### Examples + + + + +``` +manifest: + remotes: + - name: zmkfirmware + url-base: https://github.com/zmkfirmware + projects: + - name: zmk + remote: zmkfirmware + revision: main + import: app/west.yml + self: + path: config +``` + + + + +``` +manifest: + remotes: + - name: zmkfirmware + url-base: https://github.com/zmkfirmware + - name: okke-formsma + url-base: https://github.com/okke-formsma + projects: + - name: zmk + remote: okke-formsma + revision: macros + import: app/west.yml + self: + path: config +``` + + + + +``` +manifest: + remotes: + - name: zmkfirmware + url-base: https://github.com/zmkfirmware + - name: mcrosson + url-base: https://github.com/mcrosson + projects: + - name: zmk + remote: mcrosson + revision: feat-behavior-sleep + import: app/west.yml + self: + path: config +``` + + + diff --git a/docs/sidebars.js b/docs/sidebars.js index e98b3f81..4153b308 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -14,6 +14,7 @@ module.exports = { "features/displays", "features/encoders", "features/underglow", + "features/under-development", ], Behaviors: [ "behaviors/key-press",