DSC-BRAIN USER GUIDE · DOCS MAINTENANCE
Style guide for these pages
Voice, naming, page template, and the header stamps every page must carry.
● verified for 9.0.0 · firmware train 8.2.0.0
● last verified 2026-09-17 · mirrored 2026-09-15
Voice
Calm, exact, honest. Say what the kit does and why, in the words the dashboard uses. Prefer what · process · expected in that order. No marketing.
Naming
- DSC-Brain for the Pi and dashboard; hub for the climate controller; DSC-Control or the panel for the touch screen.
- Probe and Plant, never Seat or POT (except when explaining the Devices page, where seat is the internal word the UI shows).
- Zones are the room, the 4×8 and the 2×4.
- Desk names exactly as on the nav: Overview, Climate, Root, Light, Plants, CannaLib, Logs, Alerts, Kit, Twin. Settings sections as on the rail.
- Breadcrumbs with ›: Settings › Devices › Cameras. Deep links in code:
#/settings/devices#cameras. - Units always shown; metric only.
Page template
- One-line lead quote or callout that says what the page is (the desk headline where one exists).
- Sections in the order a user meets things on screen.
- Tables for controls: Control · What it does · Use it when.
- A callout for anything that can surprise or harm (a refusal block for irreversible actions).
- What it does not do or Not on this release when the honest answer is a limitation.
Header stamps every page must carry
- Section and reading order (the eyebrow line and the section index).
- verified for: surface version and firmware train.
- last verified: the date the page was checked against the code.
- Summary: the one-line lead under the title, used by the section index.
What not to write
- Anything from a plan document as if shipped.
- Default passwords, API keys, addresses or hotspot names. Say where they are (the kit card, the settings page), not what they are.
- Internal script names beyond the SSH fallbacks a maintainer needs.
DSC-Brain user guide · Style guide for these pages · this page is edited on the site; the Notion original was retired after the mirror
