Merge fbcc089 into 0f9c0da

seanbudd · web-flow · commit a50d9472b2db · 2022-07-20T12:09:23.000+10:00
diff --git a/devDocs/featureFlags.md b/devDocs/featureFlags.md
@@ -142,3 +142,6 @@ self.loadChromeVbufWhenBusyCombo.resetToConfigSpecDefault()
 # save GUI value to config:
 self.loadChromeVbufWhenBusyCombo.saveCurrentValueToConf()
 ```
+
+## User Guide Documentation
+Refer to [User Guide Standards](./userGuideStandards.md#feature-settings)
diff --git a/devDocs/userGuideStandards.md b/devDocs/userGuideStandards.md
@@ -0,0 +1,33 @@
+# User Guide Standards
+This document aims to create a standard style guide for writing documentation in the User Guide.
+
+The principles outlined in ["The Documentation System" guide for reference materials](https://documentation.divio.com/reference/) are encouraged when working on the User Guide and this document.
+
+## General standards
+- Key commands (e.g. ` ``NVDA+control+upArrow`` `):
+  - should be written in lowerCamelCase
+  - encapsulated in monospace code-block formatting
+  - NVDA should be capitalized
+- When referring to Windows terminology, follow the [Windows style guide](https://docs.microsoft.com/en-us/style-guide/welcome/).
+  - For instance, instead of "system tray" refer to "notification area"
+
+## Feature settings
+
+Feature flags should be included using the following format.
+
+`FeatureDescriptionAnchor` should not include the settings category.
+Once the anchor is set it cannot be updated, while settings may move categories.
+
+```text2tags
+==== The name of a feature ====[FeatureDescriptionAnchor]
+: Default
+  Enabled
+: Options
+  Default (Enabled), Enabled, Disabled
+: ``NVDA+o``
+  Toggle this feature
+:
+
+This setting allows the feature of using functionality in a certain situation to be controlled in some way.
+If necessary, a description of a common use case that is supported by each option.
+```
diff --git a/user_docs/styles.css b/user_docs/styles.css
@@ -55,3 +55,39 @@ pre {
   padding: 1em;
   border-left: 2px solid #69c;
 }
+
+/* 
+Definition styling.
+https://txt2tags.org/markup.html
+In t2t, definition lists are defined as follows:
+
+: Definition list
+  A list with terms
+: Start term with colon
+  And its definition follows
+:
+*/
+
+/* Definition list */
+dl {
+  display: grid;
+  grid-template-columns: max-content auto;
+}
+
+/* Term of a definition */
+dl > dt {
+  display: inherit;
+  grid-column-start: 1;
+  font-style: italic;
+  font-weight: bold;
+  font-size: small;
+}
+
+/* Definition of a term */
+dl > dd {
+  display: inherit;
+  grid-column-start: 2;
+  margin-inline-start: 1em;
+  font-size: small;
+  font-style: italic;
+}
