Commit Graph

5 Commits (f0da486fabdbe05023e03d89c000229410800713)

Author SHA1 Message Date
kiilerix da6d6ce2e1
Some docs improvements (#15845)
* docs: clarify in "Keymap Overview" what LAYOUT is and isn't

It is not strictly necessary to use LAYOUT macros in keyboard.c, but it
is a convenient abstraction of hardware internals, allowing focus on the
physical keyboard layout.

From the C source point of view LAYOUT is macro with a parameter list,
which expands to a array of rows that each is an array with a keyboard
scancode for each column. A macro parameter list is not an array, and
even less a single array.

Perhaps no big deal, but also no reason to give incorrect hints.

* docs: update "Understanding QMK's Code" to current code structure introduced in 96e2b13d1d

This part of the documentation was no longer correct. I tried updating
it, mainly copy editing and using github links to latest release.

This is not trying to fix all problems, but just trying to fix some
problems while reusing much of the old phrases and structure.

* Update docs to use "qmk format-python"
2022-03-05 15:58:50 +11:00
Jouke Witteveen 14f886d03b
[Docs] Address some typos (also in moonlander matrix.c) (#16248)
* [Docs] Fix repeated words

* [Keyboard] Fix moonlander output

The left/right orientation differs from Ergodox EZ.
2022-02-06 17:36:44 +00:00
Erovia fdcea06336
CLI/Docs: Fix the format commands' name (#13668)
PR #13296 changed the name of the `cformat` and `pyformat` commands to
`format-c` and `format-py` respectively. This PR updates the documentation
and some parts of the CLI to use the new names.
Also add documentation for the new `format-text` subcommand, introduced
in the same PR.
2021-07-23 21:41:33 +01:00
Takeshi ISHII e184da91a6
[Update] Japanese translation of docs/cli.md and docs/cli_commands.md (#9536)
* update docs/ja/cli.md

* update docs/ja/cli_commands.md

* Update docs/ja/cli.md

Co-authored-by: shela <shelaf@users.noreply.github.com>

* update docs/ja/cli_commands.md

Co-authored-by: shela <shelaf@users.noreply.github.com>
2020-06-28 20:27:06 +09:00
shela 8566a684bc
Add Japanese translation of cli_commands.md (#8513) 2020-03-31 19:21:47 +09:00