DSC-BRAIN USER GUIDE · DOCS MAINTENANCE
How to keep this guide current (per release)
The release-time procedure for this site: log the release, triage the changelog against the source-of-truth map, mark the affected guide pages for review, fix them in the Divi editor, restamp, done.
● verified for 9.0.0 · firmware train 8.2.0.0
● last verified 2026-09-17 · mirrored 2026-09-15
The guide lives on this site as ordinary pages. Every page carries two stamps in its header: verified for (surface version and firmware train) and last verified (date). Keeping it current is a filter, not a re-read.
When a release is cut
- Log the release on the DSC releases page: version, date, kind (SD image / surface only / hotfix), firmware train, and the user-facing highlights from the changelog. Add a Journey event for it.
- Triage the changelog line by line against the Source-of-truth map page. For each changed area, list every guide page whose sources or watch for line mentions that area. That list is the work queue.
- Fix the pages. Open each queued page in the Divi editor, re-read the named source files, correct the text, and update the two header stamps (verified for, last verified). Save and publish.
- Check the always-touched pages every release regardless of the changelog: Versions explained, Known limitations, Alert catalogue (must match the brain's default severity table one for one), Routes and deep links, Flash the SD image (image file name), Welcome (version line).
- Close the release by noting the date and the pages touched on the release entry.
Grep hints for the triage
Run these in the repo to find user-visible changes fast:
git diff v<prev>..v<new> --stat -- frontend/src/routes.ts frontend/src/pages/settings/settingsIndex.ts brain/dsc_brain/alert_prefs.py brain/dsc_brain/journal_actions.py brain/dsc_brain/zigbee_catalog.py brain/dsc_brain/zigbee_policies.py brain/dsc_brain/automation_rules.py brain/dsc_brain/settings.py brain/dsc_brain/paths.py
git diff v<prev>..v<new> -- frontend/src/pages/SetupPage.tsx
grep -rn 'label="' frontend/src/pages | diff - <previous run>
Help tips in the dashboard are the closest thing to in-app docs; a changed help tip is a changed page here.
Rules of thumb
- The About card on a real kit beats README and release notes; both have lagged the code.
- The firmware stamp only moves on a flash. A release cut changes Expected firmware, not the fleet.
- Never document a feature from a plan doc. Plans describe intent; only the changelog, the code and a live kit describe what shipped.
- Keep the voice: calm, exact, honest. Probe and Plant, never Seat or POT. No vendor names beyond the ones the UI itself shows.
Where the guide lives
The guide was mirrored to this site once, by hand, on 2026-09-15 from the original working notes; those notes are retired. The pages here are the only copy. Edit them in place; do not rebuild them from anywhere else.
DSC-Brain user guide · How to keep this guide current (per release) · this page is edited on the site; the Notion original was retired after the mirror
