Commit Graph

1203 Commits (3d183ed7a0af937279eea5f981be505f0d13dc07)

Author SHA1 Message Date
Drashna Jaelre 40e694ea0d
Add last breaking changes log to sidebar (#10680)
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-10-18 15:46:47 +11:00
Morten Linderud 7d5ba88e6f
50-qmk.rules: Move udev rules from documentation into a file (#10664)
This makes it overall easier to package for downstream distributions
instead of keeping tabs with inline documentation.

Signed-off-by: Morten Linderud <morten@linderud.pw>
2020-10-17 20:30:18 +01:00
James Young de68d294ec
[Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049) 2020-10-18 03:50:32 +11:00
Ryan f0a1ab5488
MSYS and WSL installation improvements (#10593) 2020-10-18 02:45:21 +11:00
shela 39c473a639
[Docs] Update feature_combo.md of Japanese document (#10671) 2020-10-17 03:19:06 -07:00
Andre Azzolini 139d28eaae
[Docs] Add link to Tap-Hold Configuration Options from Mod-Tap (#10548) 2020-10-15 21:23:24 -07:00
shela a2af0a352b
Update other_vscode.md of Japanese document (#10604)
* Update Japanese document

* Fix inline code

* Update docs/ja/other_vscode.md

Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>

Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-10-15 03:24:26 +09:00
shela f706e1e80e
Update Japanese document (#10607) 2020-10-14 05:09:59 +09:00
Takeshi ISHII 46c77febf7
[Docs] Japanese translation of docs/pr_checklist.md (#10415)
* japanese translation of docs/pr_checklist.md

* update docs/ja/pr_checklist.md

* update docs/ja/pr_checklist.md

* update docs/ja/pr_checklist.md

* add :id=lite to docs/ja/custom_matrix.md

* add :id=... to docs/ja/custom_quantum_functions.md

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

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

* Update docs/ja/pr_checklist.md

* Update docs/ja/pr_checklist.md

* Update docs/ja/pr_checklist.md

Co-authored-by: s-show <s1shimz@gmail.com>

* Update docs/ja/pr_checklist.md

Co-authored-by: s-show <s1shimz@gmail.com>

Co-authored-by: shela <shelaf@users.noreply.github.com>
Co-authored-by: s-show <s1shimz@gmail.com>
2020-10-14 05:08:26 +09:00
shela b4e7d4ffae
Update tags to check for document updates (#10606) 2020-10-13 17:03:17 +09:00
shela 4d59657b83
Fix typo within debounce documentation (#10600) 2020-10-13 01:46:16 +01:00
shela 3d9fff1d28
Update Japanese document (#10605) 2020-10-13 01:08:38 +09:00
shela 975c2422f3
Update Japanese document (#10601) 2020-10-13 01:07:59 +09:00
shela a4efb55a39
Update Japanese document. (#10599) 2020-10-13 01:07:11 +09:00
shela 96ac448a0f
Update feature_bluetooth.md of Japanese document. (#10594)
* Update Japanese document.

* Left justified.

* Update docs/ja/feature_bluetooth.md

Co-authored-by: s-show <s1shimz@gmail.com>

* Update docs/ja/feature_bluetooth.md

Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>

Co-authored-by: s-show <s1shimz@gmail.com>
Co-authored-by: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-10-13 01:06:06 +09:00
shela 216f9ed2c1
Update Japanese document. (#10589) 2020-10-13 01:05:28 +09:00
shela c66d65df58
Update Japanese document (#10603) 2020-10-13 01:02:52 +09:00
Takeshi ISHII f7e5d712c2
[Docs] Japanese translation of docs/isp_flashing_guide.md (#9896)
* start translation docs/ja/isp_flashing_guide.md

* Japanese translation is in progress.

* Japanese translation is in progress.

* Japanese translation is in progress.

* Japanese translation is in progress.

* Japanese translation is in progress.

* Japanese translation is in progress.

* Japanese translation is in progress.

* update docs/ja/isp_flashing_guide.md

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

* Update docs/ja/isp_flashing_guide.md

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

* Update docs/ja/isp_flashing_guide.md

Co-authored-by: Takuya Urakawa <urkwtky@gmail.com>

* Update docs/ja/isp_flashing_guide.md

Co-authored-by: Takuya Urakawa <urkwtky@gmail.com>

* Update docs/ja/isp_flashing_guide.md

Co-authored-by: Takuya Urakawa <urkwtky@gmail.com>

* Update docs/ja/isp_flashing_guide.md

Co-authored-by: Takuya Urakawa <urkwtky@gmail.com>

Co-authored-by: shela <shelaf@users.noreply.github.com>
Co-authored-by: Takuya Urakawa <urkwtky@gmail.com>
2020-10-13 01:01:07 +09:00
Jan-Frederick Musiol 49abff9071
changed type of process_combo_event argument in tutorial (#10621)
in tutorial for combos feature, changed type of compo_index argument of process_combo_event form uint8_t to uint16_t
2020-10-13 02:14:37 +11:00
shela a88cfa395b
Update feature_backlight.md of Japanese document. (#10592)
* Update Japanese document.

* Update tag
2020-10-10 18:16:32 +09:00
shela 6e78655e17
Update Japanese document. (#10591) 2020-10-10 18:15:22 +09:00
shela b0c8cbe462
Update Japanese document. (#10590) 2020-10-10 18:12:04 +09:00
shela 962adbea3a
Update Japanese document. (#10588) 2020-10-10 18:00:11 +09:00
Erovia a67b32425b Docs: fix udev rules
Apparently, udev does not like inline comments.
Rules with them are ignored, oops.
2020-10-06 17:29:47 -07:00
Erovia 058737f116
[CLI] Add c2json (#8817)
* Basic keymap parsing finally works

* Add 'keymap.json' creation to the qmk.keymap module

* Add tests and fix formatting

* Fix/exclude flake8 errors

* Convert keymap.c to valid keymap.json

* Fix some errors

* Add tests

* Finalize keymap.json creation, add json template

* Add docs

* Move pygments to the standard requirements

* Add support for nameless layers, fix tests

* Fix things after rebase

* Add missing 'keymap' value.

* Fix missing layer numbers from advanced keycodes

Buckwich noticed that if the advanced keycode / layer toggling key
contains a number, it goes missing.
Now we properly handle them.
Thx for noticing!

* Apply suggestions from code review

* fixup tests

Co-authored-by: Zach White <skullydazed@drpepper.org>
Co-authored-by: skullY <skullydazed@gmail.com>
2020-10-06 17:10:19 -07:00
Joe Strong 2013f63134
Fixes small typo in docs (#10515) 2020-10-05 19:21:39 +11:00
George Mao 9e9b604234
Mark 'key_count' as optional within info.json docs (#10513)
* Update reference_info_json.md

key_count is now an optional field because it is better to get the keycount by counting the elements in the layout array.

* Updated Japanese documentation as well
2020-10-03 00:42:11 +01:00
nopunin10did 0cb7133e0d
Doc followup 9942 (#10473)
* Update feature_advanced_keycodes.md

* Update mod_tap.md
2020-10-01 22:19:57 +01:00
Ryan e7acd39b78
Consolidate udev rules into a single file (#9693)
* Consolidate udev rules into a single file

* Update rules in doctor.py

* Simplify doctor rule checking

* Fix errors

* Add TMK "FEED" VID to list of deprecated udev rules

* A comma would be nice

* Split rules back up into bootloaders

* Link to docs page in "missing" case

* Add Pololu VID

* Be more specific about Caterina devices, and add LilyPad PID
2020-09-27 20:36:33 +10:00
precondition 28ff51175b
[Docs] Wording & formatting changes in the Tapping Force Hold section of the Tap Hold page + removed trailing whitespaces (#10391)
* Wording & formatting changes in Tapping Force Hold

The Permissive Hold and the Ignore Mod Tap Interrupt sections were also modified to remove the quotes
around "tapping".

* Removed all trailing whitespaces from tap hold doc

* "it's simply really:" → "it's simple really:"

* "This allows to keep the ability" → "This allows keeping the ability"

Used the gerund form of "to keep" in the Tapping Force Hold section of the Tap Hold docs.

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
2020-09-26 19:11:40 -04:00
umi 4bf5f9424e
[Docs] Japanese translation of docs/understanding_qmk.md (#10136)
* add understanding_qmk.md translation

* update based on comment

* update based on comment

* update based on comment

* update based on comment

* update based on comment
2020-09-22 14:54:33 -07:00
Peter Landoll 0fbb1e550a
Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 2020-09-22 22:31:37 +10:00
Fred Silberberg c23667608c
Add OLED driver function to determine if the screen is currently on (#10382) 2020-09-21 18:39:50 -07:00
Dustin Bosveld 2f637e4ea1
[Docs] Clarify functionality of update_tri_layer_state (#10370)
* Add information to docs
- If layer z is not a higher layer than both x and y, the layer change code
does not function correctly.

* Update docs/ref_functions.md

* Update docs/ref_functions.md

* Update docs/ref_functions.md
2020-09-21 11:35:26 -07:00
fauxpark a0305f5e7e Be more specific about Caterina devices, and add LilyPad PID 2020-09-19 05:40:25 +10:00
fauxpark c2a0cebf8b Add Pololu VID 2020-09-19 05:21:33 +10:00
fauxpark 72b1ff5899 Add TMK "FEED" VID to list of deprecated udev rules 2020-09-19 05:21:31 +10:00
fauxpark 07e37c857c Update rules in doctor.py 2020-09-19 05:21:30 +10:00
fauxpark a21e487fbc Consolidate udev rules into a single file 2020-09-19 05:21:29 +10:00
umi bc010d62ca
[Docs] Japanese translation of docs/tap_hold.md (#10017)
* add tap_hold.md translation

* update based on comment

* update based on comment

* update based on comment
2020-09-17 12:04:07 -07:00
TJ bc15c4f4ab
Update led_conf_t example (#10327) 2020-09-17 18:45:42 +01:00
undermark5 6499eb6a3c
Fixed typo in vscode docs (#10303)
.vscode/c_cpp_properies.json -> .vscode/c_cpp_properties.json
2020-09-13 14:28:30 +01:00
Takeshi ISHII d8d65bbf5f
[Docs] Update Japanese translation of feature_split_keyboard.md (#10283)
Apply #10242 changes to ja/feature_split_keyboard.md
2020-09-11 13:10:30 -07:00
umi 5f00df0c4c
[Docs] Japanese translation of docs/reference_keymap_extras.md (#10138)
* add reference_keymap_extras.md translation

* update based on comment

* update based on comment

* update based on comment
2020-09-08 14:44:36 -07:00
Takeshi ISHII 088888937a
Replace figures in docs/feature_split_keyboard.md (#10242)
* Replace figures in feature_split_keyboard.md

* fig update

* Update docs/feature_split_keyboard.md

Co-authored-by: Ryan <fauxpark@gmail.com>

Co-authored-by: Ryan <fauxpark@gmail.com>
2020-09-06 21:15:55 -07:00
Purdea Andrei f7ccbfcea8
quantum/debounce: rename debouncing algorithms (#9564)
* quantum/debounce: rename debouncing algorithms according to Issue 8763

This is the second attempt at implementation, with no ts_ and cy_ prefixes, since those will be implemented with macros.

* Debouncing documentation: Refactor, add some generic info, and merge into a single document
2020-09-06 13:13:49 -07:00
Erovia ac24f203cc
Docs/PR_checklist: Reorder, unify and pet-peeves (#10253)
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
2020-09-06 13:06:12 +01:00
umi a8a714c46e
[Docs] Japanese translation of docs/reference_configurator_support.md (#9879)
* add reference_configurator_support.md translation

* update based on comment

* update based on comment

* update based on comment

* update based on comment
2020-09-05 13:53:19 +09:00
Takeshi ISHII 82a830196f
fix link in docs/ja/*.md (#10232)
* fix link in docs/ja/feature_split_keyboard.md

* fix link in docs/ja/faq_build.md

* fix link in docs/ja/faq_general.md

* fix link in  docs/ja/faq_keymap.md

* fix link in docs/ja/how_a_matrix_works.md

* fix link in docs/ja/reference_glossary.md
2020-09-04 04:12:43 -07:00
umi 2e4a75e2bc
[Docs] Japanese translation of docs/serial_driver.md (#10014)
* add serial_drive.md translation

* update table style

* update based on comment

* update based on comment
2020-09-03 19:58:03 -07:00