Commit 8ce9d1b
committed
docs: rewrite the site for first-time installers; recolor to the brand mark
The docs had no beginner entry point. "Get Started" pointed at the wiring
guide, which opens with a lethal-voltage warning and an ASCII terminal-block
diagram, and the actual quick start lived in the README — off-site. Every
guide was written for someone who already knew what a CCA, an MPPT, or PSRAM
was.
- New "Start Here" guide: what it does in plain terms, a glossary of the
jargon the other pages assume, a shopping list, five numbered steps, and
how to tell it's working. The hero now points here.
- Sidebar regrouped by when you need something (Setting it up / Once it's
running / Reference) instead of alphabetically, so nobody lands in the API
tables mid-install.
- Config Builder fields gained plain-language hints. It was 15 bare labels —
"API encryption key" with no hint of what to do about it. The hints go
INSIDE the JS-toggled wrappers (cca-ip-row, cca-mac-row, display-row) so
they hide with their fields; wizard.js binds by ID only, contract intact.
- Troubleshooting opens with the four problems people actually hit, in prose,
ahead of the symptom tables.
- Configuration / Web Server / TSDB now state up front whether you need to
read them. TSDB retitled "Saving History to Flash".
- Wiring answers the unspoken question — can this break my solar system? —
before the DE/RE electrical detail.
The TSDB cadence rationale (flash writes cutting I-cache on both cores, the
~40x MTTF change from coarsening to 30 min) moved into the reference section
rather than being dropped with the rest of the simplification.
Colors: the accent ramp was green and unrelated to anything. Now taken from
the "Emitting" mark — accent-low is the optimizer body's silicon indigo
verbatim, accent-high its busbar silver. Amber keeps its one meaning. Link
text measures 11.4:1 dark / 8.5:1 light, both past WCAG AA.
Site builds clean; starlightLinksValidator passes (the read-only wiring
anchor was renamed, all three references updated).
Claude-Session: https://claude.ai/code/session_01RgSnMCa3JQigphGnPbazdw1 parent fa529a9 commit 8ce9d1b
11 files changed
Lines changed: 422 additions & 87 deletions
File tree
- site
- src
- components
- content/docs
- guides
- styles
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| 11 | + | |
| 12 | + | |
11 | 13 | | |
12 | 14 | | |
13 | 15 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
37 | 40 | | |
38 | 41 | | |
39 | | - | |
| 42 | + | |
40 | 43 | | |
41 | | - | |
| 44 | + | |
42 | 45 | | |
43 | | - | |
44 | | - | |
45 | | - | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
46 | 52 | | |
47 | 53 | | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
48 | 63 | | |
49 | 64 | | |
50 | | - | |
51 | 65 | | |
52 | 66 | | |
53 | 67 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
11 | | - | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
12 | 14 | | |
13 | 15 | | |
14 | 16 | | |
| |||
23 | 25 | | |
24 | 26 | | |
25 | 27 | | |
26 | | - | |
| 28 | + | |
27 | 29 | | |
28 | | - | |
29 | | - | |
30 | | - | |
31 | | - | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
32 | 34 | | |
33 | 35 | | |
34 | 36 | | |
35 | 37 | | |
36 | 38 | | |
37 | | - | |
| 39 | + | |
38 | 40 | | |
39 | | - | |
| 41 | + | |
40 | 42 | | |
41 | 43 | | |
42 | 44 | | |
43 | 45 | | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
44 | 50 | | |
45 | 51 | | |
46 | 52 | | |
47 | 53 | | |
48 | 54 | | |
49 | 55 | | |
50 | 56 | | |
| 57 | + | |
51 | 58 | | |
52 | | - | |
53 | | - | |
54 | | - | |
55 | | - | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
56 | 63 | | |
57 | 64 | | |
58 | 65 | | |
59 | 66 | | |
60 | | - | |
| 67 | + | |
61 | 68 | | |
62 | 69 | | |
63 | 70 | | |
| 71 | + | |
64 | 72 | | |
65 | | - | |
| 73 | + | |
66 | 74 | | |
67 | 75 | | |
68 | 76 | | |
| |||
178 | 186 | | |
179 | 187 | | |
180 | 188 | | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
181 | 199 | | |
182 | | - | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
183 | 203 | | |
184 | 204 | | |
185 | 205 | | |
186 | | - | |
| 206 | + | |
187 | 207 | | |
188 | 208 | | |
189 | 209 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
6 | 33 | | |
7 | 34 | | |
8 | 35 | | |
| |||
66 | 93 | | |
67 | 94 | | |
68 | 95 | | |
69 | | - | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
70 | 99 | | |
71 | | - | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
72 | 104 | | |
73 | | - | |
| 105 | + | |
| 106 | + | |
74 | 107 | | |
75 | | - | |
| 108 | + | |
76 | 109 | | |
77 | | - | |
| 110 | + | |
| 111 | + | |
78 | 112 | | |
79 | | - | |
80 | | - | |
81 | | - | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
82 | 118 | | |
83 | | - | |
| 119 | + | |
84 | 120 | | |
85 | 121 | | |
86 | 122 | | |
| |||
145 | 181 | | |
146 | 182 | | |
147 | 183 | | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
148 | 188 | | |
149 | 189 | | |
150 | 190 | | |
| |||
182 | 222 | | |
183 | 223 | | |
184 | 224 | | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
185 | 230 | | |
186 | 231 | | |
187 | 232 | | |
| |||
461 | 506 | | |
462 | 507 | | |
463 | 508 | | |
464 | | - | |
| 509 | + | |
465 | 510 | | |
466 | 511 | | |
467 | 512 | | |
| |||
0 commit comments