Browse Source

move the information to its own page

xmkb
Cody McGinnis 4 years ago committed by Pete Johanson
parent
commit
ac50e741be
  1. BIN
      docs/docs/assets/features/under-development/pr-repo-branch.png
  2. BIN
      docs/docs/assets/features/under-development/repo-branch.png
  3. BIN
      docs/docs/assets/features/under-development/repo-url.png
  4. 72
      docs/docs/customization.md
  5. 100
      docs/docs/features/under-development.md
  6. 1
      docs/sidebars.js

BIN
docs/docs/assets/features/under-development/pr-repo-branch.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

BIN
docs/docs/assets/features/under-development/repo-branch.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

BIN
docs/docs/assets/features/under-development/repo-url.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

72
docs/docs/customization.md

@ -3,9 +3,6 @@ title: Customizing ZMK/`zmk-config` folders @@ -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 @@ -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

100
docs/docs/features/under-development.md

@ -0,0 +1,100 @@ @@ -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>

1
docs/sidebars.js

@ -14,6 +14,7 @@ module.exports = { @@ -14,6 +14,7 @@ module.exports = {
"features/displays",
"features/encoders",
"features/underglow",
"features/under-development",
],
Behaviors: [
"behaviors/key-press",

Loading…
Cancel
Save