summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2020-10-29Add brightness level API to OLED driver (#10772)Ryan
* Add brightness level API to OLED driver * Set default brightness to 255
2020-10-18Add last breaking changes log to sidebar (#10680)Drashna Jaelre
Co-authored-by: Ryan <fauxpark@gmail.com>
2020-10-1750-qmk.rules: Move udev rules from documentation into a file (#10664)Morten Linderud
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-18[Docs] add "Adding Default Keymaps to QMK Configurator" doc (#10049)James Young
2020-10-18MSYS and WSL installation improvements (#10593)Ryan
2020-10-17[Docs] Update feature_combo.md of Japanese document (#10671)shela
2020-10-15[Docs] Add link to Tap-Hold Configuration Options from Mod-Tap (#10548)Andre Azzolini
2020-10-15Update other_vscode.md of Japanese document (#10604)shela
* 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-14Update Japanese document (#10607)shela
2020-10-14[Docs] Japanese translation of docs/pr_checklist.md (#10415)Takeshi ISHII
* 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-13Update tags to check for document updates (#10606)shela
2020-10-13Fix typo within debounce documentation (#10600)shela
2020-10-13Update Japanese document (#10605)shela
2020-10-13Update Japanese document (#10601)shela
2020-10-13Update Japanese document. (#10599)shela
2020-10-13Update feature_bluetooth.md of Japanese document. (#10594)shela
* 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-13Update Japanese document. (#10589)shela
2020-10-13Update Japanese document (#10603)shela
2020-10-13[Docs] Japanese translation of docs/isp_flashing_guide.md (#9896)Takeshi ISHII
* 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-13changed type of process_combo_event argument in tutorial (#10621)Jan-Frederick Musiol
in tutorial for combos feature, changed type of compo_index argument of process_combo_event form uint8_t to uint16_t
2020-10-10Update feature_backlight.md of Japanese document. (#10592)shela
* Update Japanese document. * Update tag
2020-10-10Update Japanese document. (#10591)shela
2020-10-10Update Japanese document. (#10590)shela
2020-10-10Update Japanese document. (#10588)shela
2020-10-06Docs: fix udev rulesErovia
Apparently, udev does not like inline comments. Rules with them are ignored, oops.
2020-10-06[CLI] Add c2json (#8817)Erovia
* 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-05Fixes small typo in docs (#10515)Joe Strong
2020-10-03Mark 'key_count' as optional within info.json docs (#10513)George Mao
* 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-01Doc followup 9942 (#10473)nopunin10did
* Update feature_advanced_keycodes.md * Update mod_tap.md
2020-09-27Consolidate udev rules into a single file (#9693)Ryan
* 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-26[Docs] Wording & formatting changes in the Tapping Force Hold section of the ↵precondition
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-22[Docs] Japanese translation of docs/understanding_qmk.md (#10136)umi
* 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-22Add description in Bluetooth docs for requiring NKRO to be disabled (#10359)Peter Landoll
2020-09-21Add OLED driver function to determine if the screen is currently on (#10382)Fred Silberberg
2020-09-21[Docs] Clarify functionality of update_tri_layer_state (#10370)Dustin Bosveld
* 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-19Be more specific about Caterina devices, and add LilyPad PIDfauxpark
2020-09-19Add Pololu VIDfauxpark
2020-09-19Add TMK "FEED" VID to list of deprecated udev rulesfauxpark
2020-09-19Update rules in doctor.pyfauxpark
2020-09-19Consolidate udev rules into a single filefauxpark
2020-09-17[Docs] Japanese translation of docs/tap_hold.md (#10017)umi
* add tap_hold.md translation * update based on comment * update based on comment * update based on comment
2020-09-17Update led_conf_t example (#10327)TJ
2020-09-13Fixed typo in vscode docs (#10303)undermark5
.vscode/c_cpp_properies.json -> .vscode/c_cpp_properties.json
2020-09-11[Docs] Update Japanese translation of feature_split_keyboard.md (#10283)Takeshi ISHII
Apply #10242 changes to ja/feature_split_keyboard.md
2020-09-08[Docs] Japanese translation of docs/reference_keymap_extras.md (#10138)umi
* add reference_keymap_extras.md translation * update based on comment * update based on comment * update based on comment
2020-09-06Replace figures in docs/feature_split_keyboard.md (#10242)Takeshi ISHII
* 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-06quantum/debounce: rename debouncing algorithms (#9564)Purdea Andrei
* 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-06Docs/PR_checklist: Reorder, unify and pet-peeves (#10253)Erovia
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
2020-09-05[Docs] Japanese translation of docs/reference_configurator_support.md (#9879)umi
* add reference_configurator_support.md translation * update based on comment * update based on comment * update based on comment * update based on comment
2020-09-04fix link in docs/ja/*.md (#10232)Takeshi ISHII
* 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