diff options
author | skullY <skullydazed@gmail.com> | 2017-08-06 20:57:57 -0700 |
---|---|---|
committer | Jack Humbert <jack.humb@gmail.com> | 2017-08-16 15:47:20 -0400 |
commit | 9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a (patch) | |
tree | 352da3e60b219405be323306bcd67a6729107d61 /docs/documentation_best_practices.md | |
parent | 9b879b1267cd5cbebf4d73595c7ca4ed52fe5ef4 (diff) | |
download | qmk_firmware-9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a.tar.gz qmk_firmware-9d1a08e38ac9937cff4e61abfd0acc26ad5fdf4a.zip |
Doc updates from going through every file
Diffstat (limited to 'docs/documentation_best_practices.md')
-rw-r--r-- | docs/documentation_best_practices.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/documentation_best_practices.md b/docs/documentation_best_practices.md index f30793181..059b25bcd 100644 --- a/docs/documentation_best_practices.md +++ b/docs/documentation_best_practices.md | |||
@@ -75,3 +75,23 @@ You can add some colors. What about a warning message? | |||
75 | What about an error message? | 75 | What about an error message? |
76 | **[error [ERROR] This is not the error you are looking for] | 76 | **[error [ERROR] This is not the error you are looking for] |
77 | ``` | 77 | ``` |
78 | |||
79 | # Documenting Features | ||
80 | |||
81 | If you create a new feature for QMK, create a documentation page for it. It doesn't have to be very long, a few sentances describing your feature and a table listing any relevant keycodes is enough. Here is a basic template: | ||
82 | |||
83 | ```markdown | ||
84 | # My Cool Feature | ||
85 | |||
86 | This page describes my cool feature. You can use my cool feature to make coffee and order cream and sugar to be delivered via drone. | ||
87 | |||
88 | ## My Cool Feature Keycodes | ||
89 | |||
90 | |Long Name|Short Name|Description| | ||
91 | |---------|----------|-----------| | ||
92 | |KC_COFFEE||Make Coffee| | ||
93 | |KC_CREAM||Order Cream| | ||
94 | |KC_SUGAR||Order Sugar| | ||
95 | ``` | ||
96 | |||
97 | Place your documentation into `docs/feature_<my_cool_feature>.md`, and add that file to the appropriate place in `docs/_summary.md`. If you have added any keycodes be sure to add them to `docs/keycodes.md` with a link back to your feature page. | ||