From abe35ec578b09151fea47ef55ef678ac65cd50ac Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Tue, 8 Feb 2022 06:34:29 -0700 Subject: [PATCH] settings style guide --- .../style-guides/settings.md | 95 +++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 docs/about-documentation/style-guides/settings.md diff --git a/docs/about-documentation/style-guides/settings.md b/docs/about-documentation/style-guides/settings.md new file mode 100644 index 00000000..d7d0ec9e --- /dev/null +++ b/docs/about-documentation/style-guides/settings.md @@ -0,0 +1,95 @@ +--- +id: style-guide-settings +title: Style Guide - Settings Pages +sidebar_label: Settings Pages +--- +## Overview +Setting pages should focus solely on settings and configuring the device. Hardware is often a related topic, however these pages should not attempt to explain attaching hardware. Mention that hardware is required and link to the appropriate page(s). + +## Layout + +### Overview +This section should describe the group of settings and what they do for the device. + +### Settings +This section starts with an alphabetized table of settings, available values, and default values. + +Available values should be listed with tick marks `` surrounding the value. + +| Value Type | Example | +| :--------: | :-----: | +| Boolean | `true`, `false` | +| List | `apple`, `banana`, `orange` | +| Range | `0`-`100` | + +After the table each setting is described in brief detail. If the available options for a setting need additional explanation, a table should be used to describe each available option. + +### Details +If additional details are needed, this optional section can explain that. These would include prerequisites, links to hardware guides, etc. + +### Examples +This optional section can have examples of configurations needed where multiple settings are required to be set up for a specific use case. + +## Example Template +```markdown title="Template for Settings Pages" +--- +id: unique-id +title: Title for Page +sidebar_label: Label for Sidebar +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +## Overview + + + +## Settings + + +| Setting | Acceptable Values | Default | +| :-----: | :---------------: | :-----: | +| my_setting_with_options | `apple`, `banana`, `orange` | `apple` | + + +### my_setting_with_options + + + +| Value | Description | +| :---: | :---------: | +| `apple` | Description of apple (default) | +| `banana` | Description of banana | +| `orange` | Description of orange | + + + + + CLI content here + + + Android content here + + + iOS content here + + + Web content here + + + +## Details + + +## Examples + +```