Skip to content

Commit

Permalink
[Docs] Touch up documentation templates & porting keyboard docs (qmk#…
Browse files Browse the repository at this point in the history
  • Loading branch information
waffle87 authored Jan 13, 2023
1 parent c965243 commit b756c53
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
12 changes: 12 additions & 0 deletions docs/documentation_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
5 changes: 2 additions & 3 deletions docs/porting_your_keyboard_to_qmk.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,16 +147,15 @@ 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

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

Expand Down

0 comments on commit b756c53

Please sign in to comment.