Qmk_firmware: Documentation clarifications

Created on 25 May 2019  Â·  5Comments  Â·  Source: qmk/qmk_firmware

As part of implementing support for a new keyboard I had to do some digging into the documentation. This resulted in a few questions that I think could be clarified in the documentation.

  1. Should the layout macros be named LAYOUT_ansi or ex. LAYOUT_tkl_ansi to work with the layouts feature.
  2. The hardware options specifies that setting BACKLIGHT_PIN to either pin B5, B6 or B7 will use hardware PWM. But the backlight caveats also mentions pin C6.
  3. The contributing documentation states that one should standardise on my_layers and my_keycodes. But the actual template used when creating a new keyboard uses no layers enum and custom_keycodes for the keycodes.
core documentation question solved

All 5 comments

The layout macros need to match the layouts under layouts/default in both name and arguments (so a TKL ANSI layout should be named LAYOUT_tkl_ansi and take 87 arguments laid out in the standard TKL arrangement).

For the backlight pin, yeah, the config options page is most likely out of date in more than just that area. Hardware PWM is definitely supported on C6 on the ATmega32U4, and also D4 for the ATmega32A.

It doesn't really matter what these enums are named, since you'll rarely reference them directly, only their elements. But I think I'd prefer to standardise on layer_names and custom_keycodes.

Was this still an issue?

Eg, do we need to take action here, or was this okay to close this issue?

Addressed point 2 in #6102 just now.

This issue has been automatically marked as resolved because it has not had activity in the last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity occurs.

I think these have all been dealt with.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

fredizzimo picture fredizzimo  Â·  4Comments

henrebotha picture henrebotha  Â·  4Comments

mrceephax picture mrceephax  Â·  4Comments

fredizzimo picture fredizzimo  Â·  4Comments

drashna picture drashna  Â·  3Comments