summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCody McGinnis <brainwart@gmail.com>2021-03-01 21:59:02 -0500
committerPete Johanson <peter@peterjohanson.com>2021-03-10 13:45:50 -0500
commitac50e741be88b043c47e65c13770ba24384c45ae (patch)
tree701d223956ceac1a825639e5d95194d529b4ae6b
parentdaf10d9741f7f78e2169b8f337b75764ccd402c7 (diff)
move the information to its own page
-rw-r--r--docs/docs/assets/features/under-development/pr-repo-branch.pngbin0 -> 75255 bytes
-rw-r--r--docs/docs/assets/features/under-development/repo-branch.pngbin0 -> 63626 bytes
-rw-r--r--docs/docs/assets/features/under-development/repo-url.pngbin0 -> 78981 bytes
-rw-r--r--docs/docs/customization.md72
-rw-r--r--docs/docs/features/under-development.md100
-rw-r--r--docs/sidebars.js1
6 files changed, 101 insertions, 72 deletions
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 0000000..68856d0
--- /dev/null
+++ b/docs/docs/assets/features/under-development/pr-repo-branch.png
Binary files 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 0000000..741e69a
--- /dev/null
+++ b/docs/docs/assets/features/under-development/repo-branch.png
Binary files 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 0000000..aed3713
--- /dev/null
+++ b/docs/docs/assets/features/under-development/repo-url.png
Binary files differ
diff --git a/docs/docs/customization.md b/docs/docs/customization.md
index 40c64ea..626a291 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/<shield>.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.
-
-<Tabs
-defaultValue="zmk"
-values={[
-{label: 'Default', value: 'zmk'},
-{label: 'PR685: Macros', value: 'macros'},
-{label: 'PR649: Add &sleep behavior', value: 'sleep'},
-]}>
-<TabItem value="zmk">
-
-```
-manifest:
- remotes:
- - name: zmkfirmware
- url-base: https://github.com/zmkfirmware
- projects:
- - name: zmk
- remote: zmkfirmware
- revision: main
- import: app/west.yml
- self:
- path: config
-```
-
-</TabItem>
-<TabItem value="macros">
-
-```
-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
-```
-
-</TabItem>
-<TabItem value="sleep">
-
-```
-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
-```
-
-</TabItem>
-</Tabs>
-
## 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 0000000..486ea5d
--- /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
+
+<Tabs
+defaultValue="zmk"
+values={[
+{label: 'Default', value: 'zmk'},
+{label: 'PR685: Macros', value: 'macros'},
+{label: 'PR649: Add &sleep behavior', value: 'sleep'},
+]}>
+<TabItem value="zmk">
+
+```
+manifest:
+ remotes:
+ - name: zmkfirmware
+ url-base: https://github.com/zmkfirmware
+ projects:
+ - name: zmk
+ remote: zmkfirmware
+ revision: main
+ import: app/west.yml
+ self:
+ path: config
+```
+
+</TabItem>
+<TabItem value="macros">
+
+```
+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
+```
+
+</TabItem>
+<TabItem value="sleep">
+
+```
+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
+```
+
+</TabItem>
+</Tabs>
diff --git a/docs/sidebars.js b/docs/sidebars.js
index e98b3f8..4153b30 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",