settings
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
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 (Required for accessibility)
CLI content here
Android (Required for accessibility)
Android content here
iOS (Required for accessibility)
iOS content here
Web (Required for accessibility)
Web content here
Details
Examples
```