You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_docs/standards.markdown
+8-7Lines changed: 8 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -9,18 +9,19 @@ sharing: true
9
9
footer: true
10
10
---
11
11
12
-
To ensure that the documentation for Home Assistant is consistent and easy to
13
-
follow for both novice and expert users, we ask that you follow a very strict
14
-
set of standards for developing the documentation.
12
+
To ensure that the documentation for Home Assistant is consistent and easy to follow for both novice and expert users, we ask that you follow a very strict set of standards for developing the documentation.
15
13
16
14
## {% linkable_title General Documentation %}
17
15
16
+
* The language of the documentation should be American-English.
17
+
* Don't put two spaces after a period and avoid the "Oxford comma".
18
+
* Be objective and not gender favoring, polarizing, race related or religion inconsiderate.
18
19
* The case of brand names, services, protocols, components, and platforms must match its respective counterpart.
19
-
* Z-Wave (**not** Zwave, Z-wave, Z Wave, or ZWave)
20
+
* Z-Wave (**not** Zwave, Z-wave, Z Wave or ZWave)
20
21
* Zigbee (**not** ZigBee)
21
-
* iCloud (**not** Icloud, icloud, or ICloud)
22
-
* Pushover (**not** PushOver, pushover, or push over)
23
-
* OwnTracks (**not** Owntracks, ownTracks, owntracks, or own tracks)
22
+
* iCloud (**not** Icloud, icloud or ICloud)
23
+
* Pushover (**not** PushOver, pushover or push over)
24
+
* OwnTracks (**not** Owntracks, ownTracks, owntracks or own tracks)
24
25
* Input Select (**not** input select or Input select)
25
26
* All headings should use the {% raw %}`{% linkable_title %}`{% endraw %} tag.
0 commit comments