Styleguide for describing UI elements
Example: In the Dashboard, under BACKEND / Connection, for the Connection Type
, select WLAN
Guideline | Example | Additional notes |
---|---|---|
For core concepts, use terms. | Dashboard | Check styleguides\ebee\terms.yml in the project root for a list of available terms. |
Italize sections and subsections | BACKEND | |
Italize buttons | Click Save & Restart | |
Put a / between section and subsection | BACKEND / Connection | |
Respect the case used in the UI | BACKEND instead of Backend | |
Put parameters in single backticks | WLAN SSID | |
Put values for parameters like so: <Value>value here</Value> | value here |