Commit Graph

928 Commits

Author SHA1 Message Date
skullY 5d35098bfc improve our docsify setup 2020-03-05 16:00:10 -08:00
skullY 8249a288d7 fix numbering 2020-03-05 16:00:10 -08:00
skullY 45e218ceec overhaul the newbs guide 2020-03-05 16:00:10 -08:00
skullY 86f6405574 More sidebar organization 2020-03-05 16:00:10 -08:00
skullY 99850aabca Add API documentation 2020-03-05 16:00:10 -08:00
James Young 3c98854044 update flashing.md
- minor typo on intro paragraph (the -> them)
- remove note about :check-size target (`make` task now does this automatically)
- heading level for Caterina commands section
- typo regarding Halfkay (come -> comes)
2020-03-05 16:00:10 -08:00
James Young 7b1b53054f update newbs_building_firmware.md
Update the text sample for when the compile task completes.
2020-03-05 16:00:10 -08:00
skullY a701c15d87 Rework the newbs guide around the qmk cli 2020-03-05 16:00:10 -08:00
skullY 1b7fa46f8e Add dark mode support 2020-03-05 16:00:10 -08:00
James Young 58fb57bfa7 _summary.md: move Auto Shift page to Software Features category 2020-03-05 16:00:10 -08:00
James Young 6af58fc25e clean up links to keycode references in newbs_building_firmware_configurator.md 2020-03-05 16:00:10 -08:00
James Young e01763b8e5 clean up callouts in newbs_building_firmware_configurator.md 2020-03-05 16:00:10 -08:00
James Young cdb5c074d3 remove some unnecessary external links
Also clean up some trailing whitespace.
2020-03-05 16:00:10 -08:00
skullY 3f1e47dbcd rework the index page 2020-03-05 16:00:10 -08:00
skullY d1c0710dec remove unused docs 2020-03-05 16:00:10 -08:00
skullY 5b14456082 more wip 2020-03-05 16:00:10 -08:00
skullY d1c18086d2 wip 2020-03-05 16:00:10 -08:00
Drashna Jaelre abd36de5ad
[Docs] Update ISP Flashing guide (#8149)
* [Docs] Update ISP Flashing guide

* Apply suggestions from code review

AKA why you shouldn't write docs at 2am

Co-Authored-By: fauxpark <fauxpark@gmail.com>
Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>

* Update workding for planck-qmk-dfu

Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
2020-03-01 22:29:26 -08:00
James Young f513a9193c
Fix the Breaking Changes doc again
WHAT YEAR IS IT?!
2020-02-29 20:46:48 -08:00
s-show 21715210e2
[Docs] translated 'feature_tap_dance.md' to japanese. (#8137)
* complete translation.

* Update docs/ja/feature_tap_dance.md

Update the file based on the suggestions.

* Update docs/ja/feature_tap_dance.md

Update the file based on the suggestions.

* Apply suggestions from code review

Update the file based on the suggestions.

* Apply suggestions from code review

Update the file based on the suggestions (Part 2).

* Apply suggestions from code review

Update the file based on the suggestions (Part 3).

* Apply suggestions from code review

Update the file based on the suggestions (Part 3).

* Apply suggestions from code review

Update the file based on the suggestions (Part 4).

* Apply suggestions from code review

Update the file based on the suggestions (Part 5).
ご提案いただいた修正案は全て確認できました。
続いて、コメント行の調整、「打つ・叩く」の変更、その他の修正を行います。

* fixed typo.

* Update the file based on the suggestions (Part 6).

* Update the file based on the suggestions (Part 7).

* Fixed sentence.

* Update docs/ja/feature_tap_dance.md

Update the file based on the suggestions (Part 8).

* Update the file based on the suggestions (Part 9).

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
2020-02-29 20:22:15 -08:00
Joel Challis f74c769a19
PWM DMA based RGB Underglow for STM32 (#7928)
* Add pwm ws2812 driver

* Add docs for pwm ws2812 driver

* Update ws2812_pwm for ChibiOS 19

Co-Authored-By: Nick Brassel <nick@tzarc.org>

Co-authored-by: Nick Brassel <nick@tzarc.org>
2020-03-01 13:05:56 +11:00
James Young cae91510dc
Breaking Changes documentation fixes 2020-02-29 12:30:38 -08:00
James Young 26eef35f07
2020 February 29 Breaking Changes Update (#8064) 2020-02-29 11:59:30 -08:00
James Young 85041ff05b
Update Breaking Changes checklist 2020-02-27 12:03:30 -08:00
James Young 7eab5ad60f
Update Breaking Changes timeline
I've been working from one timeline while the docs said something different.
2020-02-27 11:17:23 -08:00
Nick Brassel 444fd3b1cc
Add support for delays in send_string. (#8244) 2020-02-27 20:38:19 +11:00
ridingqwerty b949343b78
New feature: PERMISSIVE_HOLD_PER_KEY (#7994)
* Implement 'PERMISSIVE_HOLD_PER_KEY'

* Document 'PERMISSIVE_HOLD_PER_KEY'

Co-authored-by: GeorgeKoenig <35542036+GeorgeKoenig@users.noreply.github.com>
2020-02-25 13:25:52 -05:00
Ryan bb8d4b4d23
`send_unicode_string()`: Add support for code points > 0xFFFF (#8236) 2020-02-25 12:54:51 +11:00
Ryan 371ff9dd6f
A proper `send_string()` for the Unicode feature (#8155) 2020-02-24 10:27:25 +11:00
Jez Cope 530c997638
Add link to "Useful functions" in macro docs (#7446)
* Add link to "Useful functions" in macro docs

Help people find additional features they can activate within a macro

* Update docs/feature_macros.md

Co-Authored-By: Drashna Jaelre <drashna@live.com>

Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
2020-02-23 12:50:11 -08:00
Akaash Suresh b353028ea5
New functionality for cformat (#7893)
Fixing complexity

remove lambda

PR review fixes #1

Removing unneccesary string substitution

Handle -a and specified files

Complexity rewrite, use pathlib
2020-02-22 20:57:19 -08:00
Joel Challis 7707724dc4
Allow 30us matrix delay to be keyboard/user overridable (#8216)
* Allow 30us matrix delay to be configurable via define

* Move wait logic to matrix_common

* Move wait logic to matrix_common - fix wait includes
2020-02-21 14:49:33 +11:00
shela 58724f8dcb
[Docs] Update Japanese translation of cli.md (#8188) 2020-02-17 11:10:16 -08:00
shela 5e79da9f32
[Docs] Update Japanese translation (#8129)
* Update Japanese translation

* Update Japanese translation

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-02-17 01:03:49 -08:00
umi bbe8180ad9
[Docs] add japanese translation (detail guide part) (#7722)
* add detail-guide part

* some updates for easy reading

* some updates for easy reading

* some updates for easy reading

* some updates for easy reading

* some updates for easy reading

* some updates for easy reading

* some updates for easy reading

* some updates for easy reading

* update file based on comment

* update file based on comment

* update file based on comment

* update git command in header

* update files based on comments, and update git command in header

* update file based on comment

* update file based on comment

* update file based on comment

* update file based on comment

* update file based on comment

* update file based on comment

* update file based on comment

* update file based on comment

Co-Authored-By: shela <shelaf@users.noreply.github.com>
Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-02-17 00:50:26 -08:00
Joel Challis 17ff551275
Convert f072 backlight build error to message (#8177) 2020-02-16 11:37:21 -08:00
Erovia 3ed1223678 Drop bs4 dependency, update docs, minor improvements 2020-02-15 15:19:03 -08:00
Erovia 26f53d38d9 Another major refactoring, add documentation
Move all useful functions to the qmk module and use the cli subcommand
as a wrapper around it.
Add both inline comments and documentation.
2020-02-15 15:19:03 -08:00
Ted M Lin 9456832a3b
Fix out of bound OLED font access (#8145)
* Fix out of bound OLED font access

The default font is 1344 bytes, or a total of 224 glyphs (each 6-bytes wide).
OLED_FONT_END defaults to 224, which if used will then index off the end of
the font array. So either the documentation or code is wrong.

Instead of figuring out the rewording of the documentation, just change
the OLED_FONT_END default value to 223, to match the documentation and code.

* Add static assert to check array size

Build bomb if the font array size doesn't match to the defines.
2020-02-11 21:38:20 +00:00
ymzcdg 6a165c41cb
[Docs] doc update zh-cn (#8147)
* update zh-cn translate

Timestamp was added at the end of the document, it can help me manage version easier.

* fix _summary.md to utf-8

* fix _summary.md with vscode
2020-02-11 10:05:23 -08:00
Joel Challis fba9971555
Align max backlight level in docs (#8142) 2020-02-11 14:59:58 +00:00
Cody Bender e77188458f
Add QMK Compile Context Sensitivity (#6884)
* Add context sensitive compile, without config check

* Initial full working state. Plan to refactor

* Refactor loop for simplicity, add comments

* Update docs/cli.md with qmk compile examples

* Simplify path for keyboard derivation

* Update path to use path.join instead of concat

* Refactor keyboard path, the skully way

* Add in keymap folder support

* Add /layouts compile support

* Update docs/cli.md with empty compile in layouts

* Add comments to compile.py

* Update docs for clarity, and fix compile error typo

* Fix config option compile

* Fix layout compile and failure mode

* Add rules.mk check

* Fix variable names for global config

* Add in_layout priority

* Remove default fallback in favor of throw, update docs

* Add keymap folder context

* Fix formatting

* Add os import

* Convert to create_make_command

* Fix Travis lint errors

* Remove blank line with whitespace

* Add blank lines for readability

* Remove unnecessary config logic

* Update Docs to add flash

Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>

* Shift config precedence to MILC

Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
2020-02-07 21:48:37 +01:00
fauxpark a73c38112d
Move Grave Escape, Lock and Leader keycodes into their own sect… (#8093) 2020-02-07 15:54:14 +11:00
Joel Challis 307be48de9
Reduce SPLIT_USB_TIMEOUT by 500ms (#7637)
* Update SPLIT_USB_TIMEOUT -500ms

* Align keyboard level SPLIT_USB_TIMEOUT defaults

* Align keyboard level SPLIT_USB_TIMEOUT_POLL

* Review fixes
2020-02-04 19:37:04 -08:00
James Young c096be3831
[Docs] future branch housekeeping 2020-02-01 21:36:59 -08:00
shela ee88feb759 [Docs] Update Japanese translation (#8015) 2020-01-27 17:18:12 -08:00
James Young 72d7661b30 suggestions by skullydazed 2020-01-25 18:15:07 -08:00
James Young d0d106cef7 change Instructions listing in Docs summary 2020-01-25 18:15:07 -08:00
James Young d603e94f68 add Breaking Change PR Instructions doc 2020-01-25 18:15:07 -08:00
skullydazed 5e65af3a76 Beef up how `qmk doctor` works. (#7375)
* Beef up how `qmk doctor` works.

* improve the `git submodule status` parsing. h/t @erovia

* Fix whitespace and imports

* yapf

* Add documentation for the new doctor functionality

* Replace type_unchanged() with str()

* remove unused modules

* Update lib/python/qmk/cli/doctor.py

Co-Authored-By: Erovia <Erovia@users.noreply.github.com>

Co-authored-by: Erovia <Erovia@users.noreply.github.com>
2020-01-24 20:31:16 +01:00
Nick Brassel d13ada1162 Add customisable EEPROM driver selection (#7274)
- uprintf -> dprintf
- Fix atsam "vendor" eeprom.
- Bump Kinetis K20x to 64 bytes, too.
- Rollback Kinetis to 32 bytes as partitioning can only be done once. Add warning about changing the value.
- Change RAM-backed "fake" EEPROM implementations to match eeconfig's current usage.
- Add 24LC128 by request.
2020-01-24 12:45:58 +11:00
fauxpark 31c0fe69f6 [Docs] Misc cleanups for OLED documentation (#7864) 2020-01-19 14:05:54 -08:00
Rob Haswell a1452db98a Configuration values for starting HSV and speed (#7740)
* Define default HSV and speed for RGB matrix.

* Documentation for configuration values RGB_MATRIX_STARTUP_HUE, RGB_MATRIX_STARTUP_SAT and RGB_MATRIX_STARTUP_VAL.

* Document RGB_MATRIX_STARTUP_SPD.

* Preserve the ordering.
2020-01-18 20:11:33 +00:00
Joel Challis 6e710426a4 Add docs for 'CUSTOM_MATRIX = lite' (#7906)
* Add some docs to cover 'CUSTOM_MATRIX = lite'

* Apply suggestions from code review

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Add 'SRC += matrix.c' docs

* Update docs/custom_matrix.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

Co-authored-by: fauxpark <fauxpark@gmail.com>
2020-01-18 12:56:33 +11:00
ridingqwerty 95c24bbaf8
Implement and document TAPPING_FORCE_HOLD_PER_KEY (#7859)
* Implement and document TAPPING_FORCE_HOLD_PER_KEY

* Added "record" parameter to "get_tapping_force_hold"

* Correct typo -- remove 'IGNORE_' from 'IGNORE_TAPPING_FORCE_HOLD_PER_KEY'

Co-authored-by: GeorgeKoenig <35542036+GeorgeKoenig@users.noreply.github.com>
2020-01-17 15:49:23 -05:00
skullY 58d27cf404 Add a note explaining how to run tests 2020-01-14 07:52:14 -08:00
skullY 44168baaa7 Add a section on python tests 2020-01-14 07:52:14 -08:00
fauxpark c7b2d60a23 Move Space Cadet keycodes to their own section in keycode reference (#7889) 2020-01-14 14:02:13 +00:00
zk-phi 7f388b6553 Add per-key IGNORE_MOD_TAP_INTERRUPT feature (#7838)
* Implement IGNORE_MOD_TAP_INTERRUPT_PER_KEY

- Add configurable option IGNORE_MOD_TAP_INTERRUPT_PER_KEY
- Add function get_ignore_mod_tap_interrupt iff the option is enabled

Unless IGNORE_MOD_TAP_INTERRUPT_PER_KEY is defined, this patch does not affect the resulting binary.

* Add documentation for IGNORE_MOD_TAP_INTERRUPT_PER_KEY
2020-01-10 02:48:06 -05:00
shela 5a02cc00a4 Fix docker script and document (#7786)
Fixed error when keyboard parameter is omitted in interactive mode.
2020-01-10 00:44:16 +00:00
James Young 71de09d751 Update Breaking Changes doc timeline 2020-01-09 11:19:47 -08:00
Rob Haswell cf30c5d17f RGB matrix effect - left-right gradient (#7742)
* Left-right gradient.

* Update the comment to match the new functionality.

* CPP does integer division so this round is not necessary.

* The x-range is actually 224, update comment and use bit-shifting again.

* Update docs with gradient left-right effect and associated "DISABLE" option.
2020-01-07 21:25:17 +00:00
Takeshi ISHII b3b115bcc4 [Docs] Update check commands in Japanese documents (#7787)
The Japanese documents included a sample command to check the original document changes. But there was something wrong, so I fixed it.
2020-01-05 23:43:11 -08:00
James Young c1feeaa57f
Update Breaking Changes doc for 2020-02-29 merge 2020-01-04 12:24:51 -08:00
shela 6e520a721d [Docs] fix installation commands for macos (#7785)
* [Docs] fix installation commands for macos

* Update docs/getting_started_build_tools.md
2020-01-03 22:57:59 -08:00
shela 8b80cf853b [Docs] Update Japanese translation (#7783)
* [Docs] Update translation

* Apply suggestions from code review

* Update docs/ja/config_options.md

* Update docs/ja/newbs_building_firmware.md

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2020-01-03 22:57:03 -08:00
Takeshi ISHII 3fd8f160c3 [Docs] Added description of LIB_SRC to docs/config_options.md (#7765)
And LINK_TIME_OPTIMIZATION_ENABLE move to 'Build Options' section.
2020-01-02 14:47:27 -08:00
Casper Weiss Bang dd04079098 Fixed a small typo (#7743) 2020-01-03 08:06:46 +11:00
umi 91013d452f [Docs] add japanese translation (faq part) (#7464)
* add faq part

* add faq part

* add faq part

* add faq part

* add faq part

* update for link

* update for a punctuation

* update files based on comments

* restore removed git diff header

* correct pathname on git diff header

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update file based on comment

* update file based on comment

* update file based on comment

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
Co-Authored-By: satt99 <39004890+satt99@users.noreply.github.com>
2020-01-01 18:06:55 -08:00
Joel Challis 680ebef086
SPI DMA based RGB Underglow for STM32 (#7674)
* Initial stash of ws2812 spi driver

* Update comment, add sync backup plan

* Add testing notes to spi ws2812 driver

* Align RGBW error messages
2019-12-31 17:26:40 +00:00
Drashna Jaelre a52e55ec09 [Docs] Update macOS related issues in docs (#7744)
* [Docs] Update macOS related issues in docs

* Update faq_build.md

* Apply suggestions from code review

Co-Authored-By: fauxpark <fauxpark@gmail.com>

Co-authored-by: fauxpark <fauxpark@gmail.com>
2019-12-31 14:33:54 +00:00
Takeshi ISHII d1ed98f58b [Docs] remove docs/ja/newbs_best_practices.md (#7739)
'docs/ja/newbs_best_practices.md' has been replaced by 'docs/ja/newbs_git_*.md'.
2019-12-30 09:15:23 -08:00
Takeshi ISHII 25aaeb4f40 Japanese translation of docs/newbs_git_*.md (#7689)
* update docs/ja/newbs.md

* update docs/ja/_summary.md

* Translate docs/newbs_git_best_practices.md into Japanese.

* Translate docs/newbs_git_using_your_master_branch.md into Japanese.

* Translate docs/newbs_git_resolving_merge_conflicts.md into Japanese.

* Translate docs/newbs_git_resynchronize_a_branch.md into Japanese.

* Update docs/ja/newbs_git_using_your_master_branch.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* update ja/newbs_git_resynchronize_a_branch.md

* update ja/newbs_git_resynchronize_a_branch.md

* Update docs/ja/newbs_git_best_practices.md

* Update docs/ja/_summary.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* update ja/newbs_git_resynchronize_a_branch.md

* update ja/newbs_learn_more_resources.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

* Update docs/ja/newbs_git_resynchronize_a_branch.md

Co-Authored-By: shela <shelaf@users.noreply.github.com>
2019-12-28 23:38:33 -08:00
Takeshi ISHII 26a823082b [Docs] Fix minor differences in docs/newbs_git_resynchronize_a_branch.md (#7728) 2019-12-27 14:31:23 -08:00
shela 80e73b6210 [Docs] Update Japanese translation (#7693)
* [Docs] Update translation

* Update docs/ja/contributing.md

* Update docs/ja/contributing.md

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2019-12-27 12:09:32 -08:00
fauxpark b359830ea2 Fix file encoding for zh-cn/custom_quantum_functions.md (#7665) 2019-12-27 03:31:48 +00:00
shela 52c18ef026 [Docs] fix docs (#7642)
* [Docs] recurse-submodules option is need now

* [Docs] `tmk_core` folder is correct

* [Docs] fix typo

* [Docs] package scope has changed

* [Docs] Fix menu differences

* Update docs/arm_debugging.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Update docs/arm_debugging.md

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* fix typo

Co-authored-by: fauxpark <fauxpark@gmail.com>
2019-12-21 11:00:22 +00:00
fauxpark 3c190f8927 Improve docs "Edit Document" footer 2019-12-18 14:01:13 +11:00
umi a860da8914 [Docs] add japanese translation (basic part) (#7461)
* add basic part

* update cli

* update cli

* correct links to ja document

* update files based on comments

* update for a postpositional particle

* update for a punctuation

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

Co-Authored-By: shela <shelaf@users.noreply.github.com>
Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
2019-12-16 21:01:46 -08:00
Joel Challis adb72b60b0
Merge pull request #7276 from zvecr/feature/backlight_driver_config
Convert backlight to follow driver rules pattern
2019-12-16 16:39:54 +00:00
Takeshi ISHII b54722cc63 Change newbs.md to link to the new newbs_git_best_practices.md instead of newbs_best_practices.md. (#7633) 2019-12-14 18:16:31 +00:00
zvecr 3d54b1adf0 Convert backlight to follow driver rules pattern - update docs 2019-12-14 03:25:06 +00:00
umi 09c7304bd9 [Docs] update git command and directory name of documents (#7619) 2019-12-12 20:59:00 -08:00
Joel Challis 071eb2478f Remove mbed files (#7605)
* Remove mbed files

* Remove mbed files - fix comment

* Remove mbed logic blocks
2019-12-11 11:36:00 -08:00
fauxpark 770a4ee729 [Docs] Remove some outdated FAQ items (#7607) 2019-12-11 11:33:09 -08:00
fauxpark 698d0dbda8 Use `clock_prescale_set()` from avr-libc (#7540)
* Use `clock_prescale_set()` from avr-libc

* Remove outdated FAQ info
2019-12-11 01:26:40 +00:00
Duncan Elliot 1af31a0523 Update feature support for Proton C (#7596)
Added a couple of entries for some features not currently supported on Proton C.
2019-12-10 18:31:39 -05:00
fauxpark a8153774b5 [Docs] Fix docs fallback for pt-br (#7602) 2019-12-10 14:27:40 -08:00
Igor Hideki Trindade 10e8ed7430 [Docs] add README translation in portuguese (#7016)
* add README translation in portuguese

* add lang in menu

* Update docs/pt-br/README.md

* Update docs/pt-br/README.md

* Update docs/pt-br/README.md

* Update docs/pt-br/README.md

* Update docs/pt-br/README.md

* Update docs/pt-br/README.md

* Update docs/pt-br/README.md

* Update docs/pt-br/_summary.md

* Update sumary links

* Update README

Co-Authored-By: Álvaro A. Volpato <alvaro.volpato@usp.br>
2019-12-10 10:19:12 -08:00
hmkemppainen e676278474 fix instructions for oneshot layer handling on key release (#7554)
* fix instructions for oneshot layer handling on key release

* use ONESHOT_OTHER_KEY_PRESSED instead of ONESHOT_PRESSED

Co-Authored-By: Drashna Jaelre <drashna@live.com>
2019-12-08 02:18:05 +00:00
fauxpark a8320f20f7
Improve support and docs for ADC driver (#7191)
* Improve support and docs for ADC driver

* Comment ADC channels

* Move to Makers and Modders section, and fix usage instructions

* Flesh out intro

* Superscript 328P note

* Fix pin_to_mux LUT

* Support USB64/1287 as well

* analogReadPin() defaults to 0V mux on invalid pin

* Update pinToMux() function documentation

* Dot

* Accept (some of) the `qmk cformat` changes

* Do clang-format properly

* More wording tweaks

* Link to encoder docs
2019-12-08 12:11:29 +11:00
osjuga f275ffbdfc Minor grammar and filename fixes in docs (#7559)
Grammar in coding_conventions_c.md and coding_conventions_python.md

`rule.mk` to `rules.mk` in feature_haptic_feedback.md and feature_rgb_matrix.md
2019-12-07 23:19:18 +11:00
Gregory Gubarev e8efc46e74 [Docs] Creating RU version of getting_started_introduction (#7224)
* Creating RU version of getting_started_introduction

* Update docs/ru-ru/getting_started_introduction.md

Update "предполагается"

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

* Update docs/ru-ru/getting_started_introduction.md

Co-Authored-By: Nikita Titov <nekit94-08@mail.ru>
2019-12-06 11:25:05 -08:00
Gregory Gubarev 1b08a19e3e [Docs] Create RU ver of becoming_a_qmk_collaborator (#7226)
* Create RU ver of becoming_a_qmk_collaborator

* Updated

* Updated - collaborator to соавтор

* Update docs/ru-ru/becoming_a_qmk_collaborator.md

* Update docs/ru-ru/becoming_a_qmk_collaborator.md

* Update docs/ru-ru/becoming_a_qmk_collaborator.md

* Update docs/ru-ru/becoming_a_qmk_collaborator.md

* Update docs/ru-ru/becoming_a_qmk_collaborator.md

* Update docs/ru-ru/becoming_a_qmk_collaborator.md

* Update docs/ru-ru/becoming_a_qmk_collaborator.md

Co-Authored-By: Nikita Titov <nekit94-08@mail.ru>
2019-12-06 11:16:00 -08:00
arlenk 380e05ad6e Update getting_started_make_guide.md (#7538)
* Update getting_started_make_guide.md

clarifying that NO_PRINT and USER_PRINT should not be used at the same time.

* Update docs/getting_started_make_guide.md

Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>
2019-12-06 19:42:33 +11:00
fauxpark 3ad389de55 Add short aliases for Magic keycodes (#7541)
* Add short alias for `MAGIC_TOGGLE_NKRO`

* Add aliases for the other Bootmagic keycodes

* Replace long form in default keymaps
2019-12-05 00:44:39 -08:00
James Young 3152bf572b
[Docs] Restructure of Git Best Practices doc (#7231)
* Add "Resynchronizing an Out-of-Sync Git Branch" doc

* Update (Git) Best Practices doc title and filename

* Rename Branch Resync doc

* fork Best Practices doc into multiple files

* Add the doc list to Git Best Practices doc

* Update sidebar

* Update internal references

* Update sidebar - add subsection

* Update Your Fork's Master page title

* title case on Git Best Practices main doc

* ... and in the Resynchronizing a Branch doc

* Please read Part 1

I worked really hard on this, okay?

* Please use branches, too.

* suggestions by mtei

* change note about adding multiple files

* note that the name given the remote repo is arbitrary

* suggestions by fauxpark

* Git Best Practices -> Best Git Practices

Reads more naturally.

* rephrase hint block regarding remote name

* rework the resynchronization instructions per mtei

* use hint boxes for reference to Part 1 doc

I may be addicted to hint boxes. I'm sorry fauxpark. 😢

* add some clarity about the upstream repo

* wordsmithing per mtei

* restyle the shell code blocks

Makes them more consistent to the other docs in this section.
2019-12-02 18:47:02 -08:00
umi da1a527c90 [Docs] add japanese translations (#7454)
* for initial commit

* for initial commit

* for initial commit

* Update led_update_kb example (#7451)

* Update led_update_kb example

* Update comment to explain pin behavior

* wordsmith

* wordsmithing 2

* Remove CR when computing BOOTLOADER_SIZE. (#7453)

* Set up language fallback for docs, and update translation guidelines (#7403)

* Set up language fallback for docs, and update translation guidelines

* Title Case

* Add ID example

* Link to emoji flag cheatsheet

* Move docs preview section to contributing.md

* Point to docs preview in the readme

* [Keyboard] Added Cans12er keyboard (#7455)

* added cans12er keyboard

* updated readme

Updated the readme to conform with the provided template from the qmk_firmware githubpage

* Update keyboards/cans12er/README.md

Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>

* Changed configuration

Changed the configuration based on the Change Request from PR #7455 made by github user noroadsleft

* [Keyboard] Update ATmega32A readme files to match template (#7462)

* Update atmega32a readme files to match template

* Update atmega32a readme files to match template - fixes

* Apply suggestions from code review

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

* update files based on comments

Co-Authored-By: Takeshi ISHII <2170248+mtei@users.noreply.github.com>
Co-Authored-By: shela <shelaf@users.noreply.github.com>
2019-12-02 11:12:02 -08:00
fauxpark f099142004 Add _summary.md for Russian docs with proper language prefix (#7514) 2019-11-30 13:01:41 +00:00
fauxpark 7164e8eeb5 Add yet another dictionary for the QMK Firmware docs sidebar heading (#7504) 2019-11-28 22:14:04 +00:00