aboutsummaryrefslogtreecommitdiff
path: root/docs/documentation_best_practices.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/documentation_best_practices.md')
-rw-r--r--docs/documentation_best_practices.md20
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?
75What about an error message? 75What 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
81If 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
86This 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
97Place 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.