~ruther/qmk_firmware

b756c53c7b7fb314136571bc1dabe4947554e702 — jack 2 years ago c965243
[Docs] Touch up documentation templates & porting keyboard docs (#19573)

2 files changed, 14 insertions(+), 3 deletions(-)

M docs/documentation_templates.md
M docs/porting_your_keyboard_to_qmk.md
M docs/documentation_templates.md => docs/documentation_templates.md +12 -0
@@ 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
```

M docs/porting_your_keyboard_to_qmk.md => docs/porting_your_keyboard_to_qmk.md +2 -3
@@ 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