-
-
Notifications
You must be signed in to change notification settings - Fork 39.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Set up language fallback for docs, and update translation guidelines #7403
Conversation
Some of the section titles (those linked from others) must also be as follows: diff --git a/docs/zh-cn/newbs_flashing.md b/docs/zh-cn/newbs_flashing.md
index 05a9eb55e..5f1899c5b 100644
--- a/docs/zh-cn/newbs_flashing.md
+++ b/docs/zh-cn/newbs_flashing.md
@@ -78,5 +78,5 @@
-## 使用命令行刷新键盘
+## 使用命令行刷新键盘 :id=flash-your-keyboard-from-the-command-line
首先,您需要知道您的键盘使用的是哪个bootloader。通常是以下四个常见的bootloader。Pro-Micro 和 clones 使用 CATERINA, Teensy 使用 Halfkay, OLKB 键盘使用 QMK-DFU, 其他的atmega32u4芯片使用DFU。 I think this description needs to be added to |
I have a suggestion. The following information at the end of
|
@mtei I moved the entire section to contributing.md, as this information can be used for any kind of docs work, not just translations. |
@fauxpark, Information on how to preview documents is also useful for users who want to create their own keymaps but do not plan to contribute. |
I'm not quite sure what you mean. This is primarily a dev tool for testing changes to the docs - if you just want to read them you can simply go to the docs site. |
I want to be able to read the document without being connected to the internet if possible. |
Okay, how's this? |
Thank you! |
* 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>
…mk#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
* for initial commit * for initial commit * for initial commit * Update led_update_kb example (qmk#7451) * Update led_update_kb example * Update comment to explain pin behavior * wordsmith * wordsmithing 2 * Remove CR when computing BOOTLOADER_SIZE. (qmk#7453) * Set up language fallback for docs, and update translation guidelines (qmk#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 (qmk#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 qmk#7455 made by github user noroadsleft * [Keyboard] Update ATmega32A readme files to match template (qmk#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>
…mk#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
* for initial commit * for initial commit * for initial commit * Update led_update_kb example (qmk#7451) * Update led_update_kb example * Update comment to explain pin behavior * wordsmith * wordsmithing 2 * Remove CR when computing BOOTLOADER_SIZE. (qmk#7453) * Set up language fallback for docs, and update translation guidelines (qmk#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 (qmk#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 qmk#7455 made by github user noroadsleft * [Keyboard] Update ATmega32A readme files to match template (qmk#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>
…mk#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
* for initial commit * for initial commit * for initial commit * Update led_update_kb example (qmk#7451) * Update led_update_kb example * Update comment to explain pin behavior * wordsmith * wordsmithing 2 * Remove CR when computing BOOTLOADER_SIZE. (qmk#7453) * Set up language fallback for docs, and update translation guidelines (qmk#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 (qmk#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 qmk#7455 made by github user noroadsleft * [Keyboard] Update ATmega32A readme files to match template (qmk#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>
…mk#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
* for initial commit * for initial commit * for initial commit * Update led_update_kb example (qmk#7451) * Update led_update_kb example * Update comment to explain pin behavior * wordsmith * wordsmithing 2 * Remove CR when computing BOOTLOADER_SIZE. (qmk#7453) * Set up language fallback for docs, and update translation guidelines (qmk#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 (qmk#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 qmk#7455 made by github user noroadsleft * [Keyboard] Update ATmega32A readme files to match template (qmk#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>
Description
Without this
fallbackLanguages
array, pages that don't exist in the selected language will 404. All links must also be prefixed with the language code, or it will revert back to English.Additionally, pointed users towards using the
qmk docs
CLI command, and used fenced code blocks in translating.md, for syntax highlighting.Also I think the country flags should be the actual emoji characters, instead of eg.
:ja:
, as some of them appear to be unsupported currently.Types of Changes
Issues Fixed or Closed by This PR
Checklist