aboutsummaryrefslogtreecommitdiff
path: root/docs/contributing.md
diff options
context:
space:
mode:
authorfauxpark <fauxpark@gmail.com>2019-11-24 03:07:15 +1100
committerJoel Challis <git@zvecr.com>2019-11-23 16:07:15 +0000
commit9ea9806d67dd3dfd775cf854b9becd35f3cdc748 (patch)
tree012f98bfce95f8bb324b98a8f137e35af9d9ee78 /docs/contributing.md
parent7874f297b384893a842e5d5cd953264eb3561b7c (diff)
downloadqmk_firmware-9ea9806d67dd3dfd775cf854b9becd35f3cdc748.tar.gz
qmk_firmware-9ea9806d67dd3dfd775cf854b9becd35f3cdc748.zip
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
Diffstat (limited to 'docs/contributing.md')
-rw-r--r--docs/contributing.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
index 04dc0da20..7c365b418 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -101,6 +101,18 @@ enum my_keycodes {
101}; 101};
102``` 102```
103 103
104### Previewing the Documentation
105
106Before opening a pull request, you can preview your changes if you have set up the development environment by running this command from the `qmk_firmware/` folder:
107
108 ./bin/qmk docs
109
110or if you only have Python 3 installed:
111
112 python3 -m http.server 8936
113
114and navigating to `http://localhost:8936/`.
115
104## Keymaps 116## Keymaps
105 117
106Most first-time QMK contributors start with their personal keymaps. We try to keep keymap standards pretty casual (keymaps, after all, reflect the personality of their creators) but we do ask that you follow these guidelines to make it easier for others to discover and learn from your keymap. 118Most first-time QMK contributors start with their personal keymaps. We try to keep keymap standards pretty casual (keymaps, after all, reflect the personality of their creators) but we do ask that you follow these guidelines to make it easier for others to discover and learn from your keymap.