summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2019-11-21[Docs] fix broken link in docs/newbs_best_practices.md (#7430)Takeshi ISHII
2019-11-20Add flake8 to our test suite and fix all errors (#7379)skullydazed
* Add flake8 to our test suite and fix all errors * Add some documentation
2019-11-20[Docs] Start of German translation of documentation (#6909)kuchosauronad0
* Initial commit * Fix links so that they point to the german translation * minor changes to the wording of some sentences * correctly capitalize second person pronouns * Fix links so that they point to the german translation * minor changes to the wording of some sentences * correctly capitalize second person pronouns * Translate newbs_learn_more_resources.md * Clear up some phrases * Add newbs_building_firmware.md, fix spelling * Add newbs_building_firmware.md, fix spelling * Update docs/de/_summary.md Danke * Update docs/de/README.md * Update docs/de/_summary.md Ich wollte es kuerzer halten damit die Navigationsleiste nicht zu breit wird, aber das ist halt die deutsche Sprache :) * Update docs/de/newbs.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs.md * Update docs/de/newbs_learn_more_resources.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs.md * Update docs/de/newbs.md * Update docs/de/newbs.md * Update docs/de/README.md * Update docs/de/README.md * Update docs/de/README.md * Update docs/de/README.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_learn_more_resources.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_learn_more_resources.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_learn_more_resources.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_getting_started.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Update docs/de/newbs_building_firmware.md * Apply suggestions from code review * Add translation of newbs_flashing.md * Apply suggestions from code review Danke * Add translation of Zadig-guide * Translate newbs_testing_debugging.md to german Co-Authored-By: Max Rumpf <max.rumpf1998@gmail.com> Co-Authored-By: geisterfurz007 <geisterfurz007@users.noreply.github.com>
2019-11-20fix feature_advanced_keycodes.md's link (#7421)Takeshi ISHII
docs/feature_advanced_keycodes.md has: ``` [Tap Dance](https://github.com/qmk/qmk_firmware/blob/master/docs/feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys) ``` change to: ``` [Tap Dance](feature_tap_dance.md#example-5-using-tap-dance-for-advanced-mod-tap-and-layer-tap-keys) ```
2019-11-19Fix typo and code indentation (#7410)Mihai Olteanu
2019-11-19[Docs] Fix Japanese country flag (#7407)shela
2019-11-17[Docs] Modified the description about setting debug_enable in ↵Takeshi ISHII
`docs/faq_debug.md`. (#7394)
2019-11-17Doc fix to conform with #7221 (#7392)Erovia
2019-11-16[Docs] Explain Tap Dance interruption (#5520)Robert Akhmerov
2019-11-15Add CLI command for flashing a keyboardjorgemanzo
A new CLI subcommand was added, flash, which behaves very similar to the already present compile CLI comamnd, but with the added ability to target a bootloader. The command is used like so: qmk flash [-h] [-b] [-kb KEYBOARD] [-km KEYMAP] [-bl BOOTLOADER] [filename]. A -kb <keyboard> and -km <keymap> is expected, or a configurator export JSON filename. A bootloader can be specified using -bl <target>, and if left unspecified, the target is assumed to be :flash. -bl can be used to list the available bootloaders. If -km <keymap> is provided, but no -kb <keyboard>, then a message is printed suggesting the user to run qmk list_keyboards.
2019-11-15Improvements to Solenoid feature (#7369)Drashna Jaelre
* Error out when Solenid pin is not defined Instead of defaulting to a (literally) random pin, error out instead. Because this pin may be used, or because that pin may not be exposed, or may not exist. * Remove 'SOLENOID_ACTIVE' setting since it's not used * Update documentation
2019-11-14[Docs] Japanese translation of docs/ja/newbs_best_practices.md (#7337)Takeshi ISHII
* Mark same as in new document #7231 * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * comment out the same marks * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * update docs/ja/newbs.md, docs/ja/newbs_best_practices.md * update docs/ja/newbs_best_practices.md * update docs/ja/newbs_best_practices.md * update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * update docs/ja/*.md's comment * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md * Update docs/ja/newbs_best_practices.md Co-Authored-By: shela <shelaf@users.noreply.github.com>
2019-11-14[Docs] Encourage newbs to not download the repo as a zip (#7353)fauxpark
* Encourage newbs to not download the repo as a zip * Tweak wording and remove Russian translation of deprecated Vista+ instructions
2019-11-14Update debounce docs (#7355)Drashna Jaelre
2019-11-12Add cli convert subcommand, from raw KLE to JSON (#6898)Cody Bender
* Add initial pass at KLE convert * Add cli log on convert * Move kle2xy, add absolute filepath arg support * Add overwrite flag, and context sensitive conversion * Update docs/cli.md * Fix converter.py typo * Add convert unit test * Rename to kle2qmk * Rename subcommand * Rename subcommand to kle2json * Change tests to cover rename * Rename in __init__.py * Update CLI docs with new subcommand name * Fix from suggestions in PR #6898 * Help with cases of case sensitivity * Update cli.md * Use angle brackets to indicate required option * Make the output text more accurate
2019-11-11Japanese translation of newbs.md and related documents. (#7300)Takeshi ISHII
* add docs/ja/newbs.md * Update docs/ja/newbs.md * Updated newbs.md * Updated newbs.md * add docs/ja/newbs_learn_more_resources.md * Update docs/ja/newbs.md * update link info 他人まかせ :-) * add docs/ja/newbs_testing_debugging.md * Update docs/ja/newbs_testing_debugging.md * Update docs/ja/newbs_testing_debugging.md * add docs/ja/newbs_building_firmware.md * update docs/ja/newbs_building_firmware.md * Update docs/ja/newbs_testing_debugging.md * Update docs/ja/newbs_building_firmware.md * Update docs/ja/newbs_building_firmware.md * Japanese translation of docs/newbs_getting_started.md * renamed: docs/QMK入門.md -> docs/ja/newbs_getting_started.md * update docs/ja/newbs_getting_started.md * add ja/newbs_best_practices.md There are no plans to translate this file. With the completion of #7231, I will open a new PR. * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * add docs/ja/newbs_flashing.md * add docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * update docs/ja/newbs_flashing.md * change original log format * update docs/ja/newbs_flashing.md * Update docs/ja/newbs_getting_started.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_building_firmware_configurator.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * Update docs/ja/newbs_flashing.md * copy docs/_langs.md and docs/index.html from #7248 Co-Authored-By: shela <shelaf@users.noreply.github.com> Co-Authored-By: takashiski <takashiskibb@gmail.com> Co-Authored-By: Takuya Urakawa <urkwtky@gmail.com>
2019-11-09Unify RGB and RGBW commands (#7297)Drashna Jaelre
* Fix unicode in comments Co-Authored-By: fauxpark <fauxpark@gmail.com> * Remove separate RGBW implementation for a unified function * Set White to 0 in RGBW LEDs This is just to get this working, later, proper brightness can be handled elsewhere. * Use us instead of nanoseconds(?) since it renders correctly on web * Remove RGBW function from arm/ws2812.h * Remove RGBW function from arm/ws2812.c * Formatting changes * Add doc info
2019-11-08[Doc] Tidy up compatible MCUs docs (#7295)fauxpark
* Tidy up compatible MCUs docs * ARM chips should have USB * 32KB soft lower limit applies to ARM as well * NXP is the manufacturer name, not Kinetis * Units
2019-11-08[Docs] Create RU ver of getting_started_github (#7225)Gregory Gubarev
* Create RU ver of getting_started_github * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update * Updated first frase * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Update docs/ru-ru/getting_started_github.md * Updated Co-Authored-By: Nikita Titov <nekit94-08@mail.ru> Co-Authored-By: nabokovas <bbkv@bk.ru>
2019-11-07ARM - ws2812 bitbang (#7173)Joel Challis
* Initial ARM bitbang ws2812 driver * Unify chibios platform to run rgblight_task * Remove 'avr only' comments from ws2812 docs * Remove 'avr only' comments from ws2812 docs * Unify chibios platform to run rgblight_task - review comments * Remove debug flags from keymap * Add comments from review * Add defines for STM32L0XX * Attempt to get arm ws2812 working on multiple gcc versions
2019-11-06New and improved lock LED callbacks (#7215)fauxpark
* New and improved lock LED callbacks * Include stdbool * Update documentation * Use full function signatures and add keyboard-level example
2019-11-04[Core] Convert Dynamic Macro to a Core Feature (#5948)Drashna Jaelre
* Convert Dynamic Macro to a Core Feature This imports the code from Dynamic Macro into the core code, and handles it, as such. This deprecates the old method but does not remove it, for legacy support. This way, no existing user files need to be touched. Additionally, this reorganizes the documentation to better reflect the changes. Also, it adds user hooks to the feature so users can customize the existing functionality. Based heavily on and closes #2976 * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Cleanup based on feedback * Add short-form keycodes and document them - add short-form keycodes to quantum/quantum_keycodes.h - document the new aliases in docs/feature_dynamic_macros.md * Add Dynamic Macros section and keycodes to docs/keycodes.md * Make anti-nesting optional * Add documentation for DYNAMIC_MACRO_NO_NESTING option * Fix Merge artifacts * Fix formatting typo in docs Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> * Remove DYNAMIC_MACRO_RANGE as it's not needed * Fix includes and layer var type
2019-11-04[Core] Add short form LTO_ENABLE (#7259)Drashna Jaelre
For drashna's sanity's sake
2019-11-04[Docs] Create RU ver getting_started_getting_help (#7227)Gregory Gubarev
* Create RU ver getting_started_getting_help * uodate RU ver of getting_started_getting_help * Update docs/ru-ru/getting_started_getting_help.md Co-Authored-By: nabokovas <bbkv@bk.ru> Co-Authored-By: Nikita Titov <nekit94-08@mail.ru>
2019-11-03Adds raw write functions to the OLED driver (#7237)Thomas Baart
* Added oled_write_raw and oled_write_raw_P functions to the OLED driver * Added oled_write_raw method calls to feature_oled_driver.md
2019-11-03Smallish overhaul of Auto-Shift feature (#6067)Drashna Jaelre
* Fix edge case when using One Shot Layer with Auto Shift, and it not triggering the cleanup * Remove junk code (no longer used) * Replace `(un)register_code` calls with `tap_code` where appropriate * Fixed up Switch check to be more readable (less verbose) * Simplified modifier check (if it comes back non-zero, there are mods) * Add additional function calls for autoshift settings * Made all variables static, since there are function calls to get their status * Fixed up documentation * Re-add special characters that were missed * formatting pass
2019-11-03French translation - FAQ section (#6995)Xavier Hahn
* Translated faq.md and added all other files (copy from English) * Translated driver_installation_zadig.md in French * Translated faq_build.md in French * Translated faq_debug in French * Translateed faq_general.md in French * Translated first part of faq_keymap.md * Renamed docs/fr-FR folder to docs/fr-fr * Finished translation of faq_keymap.md * Update faq_build.md * Review (#3) * Review * Update docs/fr-fr/faq_keymap.md * Update docs/fr-fr/faq_debug.md * Fix some PR comments Co-Authored-By: Noan Mousy <4sstylz@protonmail.ch> Co-Authored-By: Wermeille Bastien <bastien.wermeille@gmail.com>
2019-11-02Use task driven PWM for CTPC until ARM can provide automatic configuration ↵Joel Challis
(#6928) * Use task driven PWM for CTPC until ARM can provide automatic configuration * Update CTPC docs to cover backlight
2019-11-02Initial migration of software PWM backlight (#6709)Joel Challis
* Initial migration of software PWM backlight * First pass at backlight driver docs * Correct driver name in docs * Run backlight_task when using BACKLIGHT_PINS * Resolve backlight docs TODOs
2019-11-02correct description (#7240)umi
2019-10-31[Docs] Add Spanish translation for hardware documentation (#7161)michizhou
* Add Spanish translation for hardware documentation * Finished Spanish translations for hardware docs * Resolved errors in Spanish page translations * Corrected misspelled folder name in documentation Co-Authored-By: Karey Higuera <karey.higuera@gmail.com> Co-Authored-By: José Ignacio Amelivia Santiago <ohcan2@gmail.com>
2019-10-31[Docs] Spanish translation (#7068)José Ignacio Amelivia Santiago
* add all translation docs to translating.md * Adding Spanish folder and README.md * Adding Spanish to the langs file * Adding a Spanish summary file * Small corrections on the Spanish README file * Adding Spanish newbs.md * Translate some newbs documentation * Adding the translated newbs getting started file * Adding the building firmware file * Adding a translated building firmware with configurator file * Adding the flashing guide * Adding the newbs_testing_debugging file * Apply suggestions from code review * QMK Configurator -> Configurador QMK Co-Authored-By: Karey Higuera <karey.higuera@gmail.com>
2019-10-31[Docs] Add he-IL (Hebrew) Translation (#7001)Guy Khmelnitsky
* Add he-IL (Hebrew) Translation * Add Hebrew to SUMMARY * Try RTL * Add RTL text * Lowercase folder names * Update lowercase folder in Summary * Adding getting_started_introduction.md * Add Proton C Conversion translation * Add Becoming a QMK Collaborator Translation * Add FAQ translation * Add Hardware translation * Documentation Best Practices translation * Add FAQ General translation * Align docs RTL * Add Becoming a QMK Collaborator Translation * Translate Getting Started - Getting Help * Translate Getting Started With Github * Code sections should be alligned to the left * Code sections should be alligned to the left * Code sections should be alligned to the left * Revert "Code sections should be alligned to the left" This reverts commit d0c46e90c4915ceebe7c5182aca2b75afad25df0. * Add Markdown aligned to the left * Update quantum_keycodes.md * Update proton_c_conversion.md * Translate Newbs Learn More Resourses
2019-10-30[Docs] Fix dunder names being accidentally bolded (#7217)lf
* Fix dunder names being accidentally bolded * Update docs/coding_conventions_python.md Co-Author: fauxpark <fauxpark@gmail.com> * Change all the "names to avoid" to use backticks
2019-10-30[Docs] Update getting_started_vagrant.md (#7203)Rico Sta. Cruz
2019-10-30Remove obsolete note about media keys in MacOS (#6631)Steve Purcell
* Remove obsolete note about media keys in MacOS KC_MNXT and KC_MPRV work fine on MacOS, so this note is obsolete. * Document behaviour of MEDIA_FAST_FORWARD/MEDIA_REWIND codes on MacOS * Small typo fix, and make OS-dependent keycode claim less absolute * Update docs/keycodes_basic.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-10-29 Refactor ps2avrgb i2c ws2812 to core (#7183)Joel Challis
* Refactor ps2avrgb i2c ws2812 to core * Refactor jj40 to use ws2812 i2c driver * Refactor ps2avrgb template to use ws2812 i2c driver * Add ws2812 stub files * clang-format and driver config * Add ws2812 driver docs * Fix default config values * Update tmk_core/protocol/vusb/main.c Co-Authored-By: Drashna Jaelre <drashna@live.com>
2019-10-30Update feature_bluetooth.md (#7193)Spaceman
* Update feature_bluetooth.md * Update feature_bluetooth.md * Update docs/feature_bluetooth.md Co-Authored-By: Joel Challis <git@zvecr.com> * Update docs/feature_bluetooth.md Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-10-29[Docs] Fix some misspells in French documentation (#7171)Wermeille Bastien
* Fix some spelling mistakes * Fix some misspell in french documentation * Small misspell fix in French in ChangeLog
2019-10-29[Docs] Translated "CLI" documentation to German (#7178)Dominic Fleckner
* Translated "CLI" documentation to German > * Weise den User an, die Umgebungs-Variable `QMK_HOME` zu setzen, um die Firmware-Quelle anders einzustellen als `~/qmk_firmware`. - I wasn't quite sure with this translation, as I didn't understand the context in the original English docs. - The link to the CLI Configuration page is currently not working, due to it being missing in German. * Update docs/de/cli.md - typo * Update docs/de/cli.md - added Installation option into documentation * Update docs/de/cli.md - changed article for CLI * Update docs/de/cli.md Spelling * Update docs/de/cli.md Spelling * Update docs/de/cli.md de-anglicization * Update docs/de/cli.md Spelling * Update docs/de/cli.md Synonym * Update docs/de/cli.md Added Installation option * Cleaned up installation option duplicate Co-Authored-By: kuchosauronad0 <22005492+kuchosauronad0@users.noreply.github.com>
2019-10-29[Docs] Update flashing information to include :flash target (#6999)Drashna Jaelre
* Update Newbs Flashing guide For the newbs that want to start flashing * Update flashing docs * Misc flashing * Attempt at flashing in french Lets hope I didn't butcher this too badly with machine transations * Update docs/feature_userspace.md * Apply language suggestions from code review * Apply suggestions from code review * Apply additional fr lang suggestions from code review * Apply suggestions from code review Co-Authored-By: fauxpark <fauxpark@gmail.com> Co-Authored-By: Noan Mousy <4sstylz@protonmail.ch> Co-Authored-By: Xavier Hahn <xavier.hahn@gmail.com> Co-Authored-By: Vincent LE GOFF <vince.legoff@gmail.com>
2019-10-29Fix the CLI docs (#6979)St. John Johnson
- Sort the commands alphabetically - Add missing `json_keymap` - Correct underscore to dash
2019-10-28[Docs] started Russian translation of Newbs Guide (partial) (#6967)Nikita Titov
* started Russian translation * added translation of some newbs docs * do not translate firmware word in name and transliterate names keeping original ones in brackets * addressed review comments * addressed more review comments Co-Authored-By: nabokovas <bbkv@bk.ru>
2019-10-28Update split i2c docs for example of when pull-ups are required (#7143)Adam Perlman
2019-10-28Update URL for `60-keyboard.hwdb` (#7185)Yadunand Prem
2019-10-26Backslash-escape pipe character in keycode lists (#7157)fauxpark
2019-10-25[Docs] Fixed internal links on Handwire page (#7154)Gouty
Some of the links were not playing nice on docs.qmk.fm, I think this fixes it.
2019-10-25[Docs] Update hand wire guide (#7044)Gouty
* Reorganised Hand Wire Guide Added some images and put the "Matrix" section in a hidden <details> section * Actually adding images this time removed .jpg from .gitignore * Hand wire guide updated Incomplete, but started making the guide more general. Will continue to add images (in imgur as requested) * Removed some more images from gitignore * testing image changes (temporary) * Update hand_wire.md * added techniques table * Tweaking the table * Finished soldering guide * Fixed some links, change image scaling * More of the same * resizing images * updated images * Update hand_wire.md * Resizing images * Update hand_wire.md * Update hand_wire.md * Create ribbon_cable.jpg * Minor updates to links * Updated firmware and flashing guidelines * Updated images to imgur links and re-added images to gitignore * Implemented requested changes. Improved wording * Added handwire helpers info and split KB info * Update hand_wire.md * Removed "the" from "the QMK toolbox" * Fixed handwire helper table and image size * Fixed a heading
2019-10-23MILC: Use dashes instead of underscores for subcommandsErovia
The subcommand functions' name follows the Python convention of using snake case, but looks odd on the command line. Fix it by converting underscores to dashes, eg.: list_keyboards -> list-keyboards.
2019-10-22Remove apostrophe from various abbreviations' plural forms (#7050)Max Rumpf
While this was historically a valid possibility, nowadays, it reads kinda weird, and the [Oxford Dictionaries Online suggests to avoid it](https://english.stackexchange.com/a/56010). Thus, I removed it everywhere I found it.
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-15 05:39:35 +0000