diff options
| author | jack <0x6A73@pm.me> | 2023-01-13 03:58:38 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-13 02:58:38 -0800 |
| commit | b756c53c7b7fb314136571bc1dabe4947554e702 (patch) | |
| tree | cf3f87c6b2b98695625c9e2d0e437f13b38adfd5 /docs | |
| parent | c965243bb70c2f3eb53bbd808bf99ea7c0ebce2d (diff) | |
[Docs] Touch up documentation templates & porting keyboard docs (#19573)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/documentation_templates.md | 12 | ||||
| -rw-r--r-- | docs/porting_your_keyboard_to_qmk.md | 5 |
2 files changed, 14 insertions, 3 deletions
diff --git a/docs/documentation_templates.md b/docs/documentation_templates.md index 91ad801662..0ad4303416 100644 --- a/docs/documentation_templates.md +++ b/docs/documentation_templates.md @@ -36,5 +36,17 @@ Make example for this keyboard (after setting up your build environment): make planck/rev4:default +Flashing example for this keyboard: + + make planck/rev4:default:flash + See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard +* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead +* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available ``` diff --git a/docs/porting_your_keyboard_to_qmk.md b/docs/porting_your_keyboard_to_qmk.md index 484d079ea6..e6a3a72cda 100644 --- a/docs/porting_your_keyboard_to_qmk.md +++ b/docs/porting_your_keyboard_to_qmk.md @@ -147,7 +147,7 @@ Next is configuring Layout Macro(s). These define the physical arrangement of ke In the above example, * `LAYOUT_ortho_4x4` defines the name of the layout macro - * It must conform to [hardware_keyboard_guidelines.md#ltkeyboard_namehgt] + * It must conform to the [layout guidelines](hardware_keyboard_guidelines.md#ltkeyboard_namehgt) * `"matrix": [0, 0]` defines the electrical position ## Additional Configuration @@ -155,8 +155,7 @@ In the above example, There are a lot of features that can be turned on or off, configured or tuned. Some of these have yet to be migrated over to [Data Driven Configuration](data_driven_config.md). The following sections cover the process for when an `info.json` option is unavailable. ### Configuration Options - -For available options for `config.h`, you should see the [Config Options](config_options.md) page for more details. +For available options for `config.h`, you should see the [Config Options](config_options.md#the-configh-file) page for more details. ### Build Options |