Spaces:
Running
Running
PanGalactic commited on
Commit Β·
4cc1ea3
1
Parent(s): 715424b
Rebuild docs.html with full Help tab experience (Quick Help + Developer Docs)
Browse files
docs.html
CHANGED
|
@@ -5,271 +5,398 @@
|
|
| 5 |
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
| 6 |
<title>Documentation β Hello World DevKit</title>
|
| 7 |
<style>
|
|
|
|
| 8 |
:root {
|
| 9 |
-
--bg: #
|
| 10 |
-
--bg-secondary: #
|
| 11 |
-
--bg-
|
| 12 |
-
--
|
| 13 |
-
--
|
| 14 |
-
--text: #
|
| 15 |
-
--text-muted: #
|
| 16 |
-
--accent: #
|
| 17 |
-
--accent-
|
| 18 |
-
--accent-
|
| 19 |
-
--
|
| 20 |
-
--
|
| 21 |
-
--
|
| 22 |
-
--
|
| 23 |
-
--
|
|
|
|
|
|
|
|
|
|
|
|
|
| 24 |
}
|
| 25 |
|
| 26 |
* { margin: 0; padding: 0; box-sizing: border-box; }
|
| 27 |
|
| 28 |
body {
|
| 29 |
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
|
| 30 |
-
background: var(--bg);
|
| 31 |
-
color: var(--text);
|
| 32 |
-
line-height: 1.
|
| 33 |
}
|
| 34 |
|
| 35 |
-
/*
|
| 36 |
.topbar {
|
| 37 |
position: sticky;
|
| 38 |
top: 0;
|
| 39 |
z-index: 100;
|
| 40 |
-
background: rgba(
|
| 41 |
backdrop-filter: blur(12px);
|
| 42 |
-
border-bottom: 1px solid var(--border
|
| 43 |
padding: 10px 20px;
|
| 44 |
display: flex;
|
| 45 |
align-items: center;
|
| 46 |
-
gap:
|
| 47 |
}
|
| 48 |
.topbar-brand {
|
| 49 |
font-weight: 700;
|
| 50 |
-
color: var(--accent-
|
| 51 |
font-size: 14px;
|
| 52 |
white-space: nowrap;
|
| 53 |
text-decoration: none;
|
| 54 |
}
|
| 55 |
.topbar-brand:hover { color: #fff; }
|
| 56 |
-
.topbar input {
|
| 57 |
-
flex: 1;
|
| 58 |
-
max-width: 480px;
|
| 59 |
-
padding: 7px 14px;
|
| 60 |
-
border-radius: 8px;
|
| 61 |
-
border: 1px solid var(--border);
|
| 62 |
-
background: var(--bg);
|
| 63 |
-
color: var(--text);
|
| 64 |
-
font-size: 13px;
|
| 65 |
-
outline: none;
|
| 66 |
-
transition: border-color 0.2s;
|
| 67 |
-
}
|
| 68 |
-
.topbar input:focus { border-color: var(--accent); }
|
| 69 |
-
.topbar input::placeholder { color: var(--text-muted); }
|
| 70 |
-
.search-info { color: var(--text-muted); font-size: 12px; min-width: 90px; }
|
| 71 |
.topbar-home {
|
| 72 |
color: var(--text-muted);
|
| 73 |
text-decoration: none;
|
| 74 |
font-size: 13px;
|
| 75 |
padding: 5px 12px;
|
| 76 |
-
border-radius:
|
| 77 |
border: 1px solid var(--border);
|
| 78 |
transition: all 0.2s;
|
| 79 |
white-space: nowrap;
|
|
|
|
| 80 |
}
|
| 81 |
-
.topbar-home:hover { color: var(--accent-
|
| 82 |
|
| 83 |
-
/*
|
| 84 |
-
.
|
| 85 |
-
max-width:
|
| 86 |
margin: 0 auto;
|
| 87 |
-
padding:
|
|
|
|
|
|
|
|
|
|
| 88 |
}
|
| 89 |
|
| 90 |
-
/*
|
| 91 |
-
.
|
| 92 |
-
|
| 93 |
-
|
| 94 |
-
|
| 95 |
-
|
| 96 |
-
|
| 97 |
-
}
|
| 98 |
-
.docs h1:first-child { margin-top: 0; }
|
| 99 |
-
.docs h2 {
|
| 100 |
-
font-size: 1.4rem;
|
| 101 |
-
margin: 40px 0 12px;
|
| 102 |
-
padding-bottom: 6px;
|
| 103 |
-
border-bottom: 1px solid var(--border);
|
| 104 |
-
color: var(--accent-light);
|
| 105 |
}
|
| 106 |
-
.
|
| 107 |
-
|
| 108 |
-
|
| 109 |
-
|
|
|
|
|
|
|
| 110 |
}
|
| 111 |
-
.
|
| 112 |
-
|
| 113 |
-
|
| 114 |
-
color: var(--
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 115 |
}
|
| 116 |
-
.
|
| 117 |
-
|
| 118 |
-
|
| 119 |
-
.docs ul, .docs ol { margin: 10px 0; padding-left: 24px; }
|
| 120 |
-
.docs li { margin: 3px 0; }
|
| 121 |
-
.docs strong { color: #f0f0f8; }
|
| 122 |
-
.docs em { color: var(--text-muted); }
|
| 123 |
-
.docs hr { border: none; border-top: 1px solid var(--border); margin: 28px 0; }
|
| 124 |
-
.docs blockquote {
|
| 125 |
-
border-left: 3px solid var(--accent);
|
| 126 |
-
padding: 8px 16px;
|
| 127 |
-
margin: 14px 0;
|
| 128 |
-
background: var(--bg-secondary);
|
| 129 |
-
border-radius: 0 8px 8px 0;
|
| 130 |
}
|
|
|
|
| 131 |
|
| 132 |
-
/*
|
| 133 |
-
.
|
|
|
|
| 134 |
width: 100%;
|
| 135 |
-
|
| 136 |
-
margin: 14px 0;
|
| 137 |
-
font-size: 0.88rem;
|
| 138 |
-
}
|
| 139 |
-
.docs th {
|
| 140 |
background: var(--bg-secondary);
|
| 141 |
-
padding: 9px 11px;
|
| 142 |
-
text-align: left;
|
| 143 |
border: 1px solid var(--border);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 144 |
font-weight: 600;
|
| 145 |
-
color: var(--accent
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 146 |
}
|
| 147 |
-
.
|
| 148 |
-
|
| 149 |
-
|
| 150 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 151 |
}
|
| 152 |
-
.
|
| 153 |
-
|
| 154 |
-
|
| 155 |
-
.
|
| 156 |
-
|
| 157 |
-
|
| 158 |
-
|
| 159 |
-
|
| 160 |
-
font-size: 0.86em;
|
| 161 |
-
color: var(--cyan);
|
| 162 |
}
|
| 163 |
-
.
|
| 164 |
-
|
| 165 |
-
|
| 166 |
-
|
| 167 |
-
|
| 168 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 169 |
border: 1px solid var(--border);
|
|
|
|
|
|
|
|
|
|
|
|
|
| 170 |
}
|
| 171 |
-
.
|
| 172 |
background: none;
|
| 173 |
padding: 0;
|
| 174 |
-
|
| 175 |
-
color: var(--text);
|
| 176 |
}
|
| 177 |
|
| 178 |
-
/*
|
| 179 |
-
.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 180 |
|
| 181 |
-
/*
|
| 182 |
-
|
| 183 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 184 |
color: inherit;
|
| 185 |
border-radius: 2px;
|
| 186 |
-
padding: 0
|
| 187 |
}
|
| 188 |
-
|
| 189 |
-
|
| 190 |
-
|
| 191 |
-
|
| 192 |
-
|
| 193 |
-
/* TOC */
|
| 194 |
-
.toc-btn {
|
| 195 |
-
position: fixed;
|
| 196 |
-
bottom: 20px;
|
| 197 |
-
right: 20px;
|
| 198 |
-
z-index: 50;
|
| 199 |
-
width: 44px;
|
| 200 |
-
height: 44px;
|
| 201 |
-
border-radius: 50%;
|
| 202 |
-
background: var(--accent);
|
| 203 |
-
border: none;
|
| 204 |
-
color: #fff;
|
| 205 |
-
font-size: 18px;
|
| 206 |
-
cursor: pointer;
|
| 207 |
-
box-shadow: 0 4px 16px rgba(124, 92, 252, 0.4);
|
| 208 |
-
display: flex;
|
| 209 |
-
align-items: center;
|
| 210 |
-
justify-content: center;
|
| 211 |
}
|
| 212 |
-
.
|
| 213 |
-
|
| 214 |
-
|
| 215 |
-
|
| 216 |
-
|
| 217 |
-
|
| 218 |
-
|
| 219 |
-
|
| 220 |
-
|
| 221 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 222 |
border: 1px solid var(--border);
|
| 223 |
-
border-radius:
|
| 224 |
-
padding:
|
| 225 |
-
|
|
|
|
| 226 |
}
|
| 227 |
-
.
|
| 228 |
-
|
| 229 |
-
|
| 230 |
-
color: var(--text-
|
| 231 |
-
|
| 232 |
-
|
| 233 |
-
|
| 234 |
-
|
| 235 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 236 |
}
|
| 237 |
-
.
|
| 238 |
-
|
| 239 |
-
|
| 240 |
-
|
| 241 |
-
.top-btn {
|
| 242 |
-
position: fixed;
|
| 243 |
-
bottom: 20px;
|
| 244 |
-
left: 20px;
|
| 245 |
-
z-index: 50;
|
| 246 |
-
padding: 6px 14px;
|
| 247 |
-
border-radius: 8px;
|
| 248 |
-
background: var(--bg-card);
|
| 249 |
border: 1px solid var(--border);
|
| 250 |
-
|
| 251 |
-
|
| 252 |
-
|
| 253 |
-
|
| 254 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 255 |
}
|
| 256 |
-
.top-btn.show { opacity: 1; }
|
| 257 |
|
| 258 |
-
/* Footer */
|
| 259 |
.foot {
|
| 260 |
text-align: center;
|
| 261 |
padding: 24px;
|
| 262 |
color: var(--text-muted);
|
| 263 |
font-size: 12px;
|
| 264 |
border-top: 1px solid var(--border);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 265 |
}
|
| 266 |
-
.foot a { color: var(--accent-light); text-decoration: none; }
|
| 267 |
|
| 268 |
@media (max-width: 768px) {
|
| 269 |
-
.
|
| 270 |
-
.
|
| 271 |
-
.topbar { flex-wrap: wrap; gap: 8px; }
|
| 272 |
-
.topbar input { max-width: 100%; }
|
| 273 |
}
|
| 274 |
</style>
|
| 275 |
</head>
|
|
@@ -277,16 +404,26 @@ mark {
|
|
| 277 |
|
| 278 |
<div class="topbar">
|
| 279 |
<a href="index.html" class="topbar-brand">Hello World DevKit</a>
|
| 280 |
-
<input type="text" id="search" placeholder="Search documentation..." autocomplete="off">
|
| 281 |
-
<span class="search-info" id="searchInfo"></span>
|
| 282 |
<a href="index.html" class="topbar-home">← Home</a>
|
| 283 |
</div>
|
| 284 |
|
| 285 |
-
<div class="
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 286 |
|
| 287 |
-
<
|
| 288 |
-
|
| 289 |
-
<
|
|
|
|
| 290 |
|
| 291 |
<div class="foot">
|
| 292 |
Built with vanilla Python + JS — no framework, no bundler<br>
|
|
@@ -295,13 +432,520 @@ mark {
|
|
| 295 |
<a href="https://www.pollen-robotics.com/reachy-mini/">Reachy Mini</a>
|
| 296 |
</div>
|
| 297 |
|
| 298 |
-
<
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 299 |
# Hello World β Reachy Mini DevKit
|
| 300 |
|
| 301 |
A community dashboard app for [Reachy Mini](https://www.pollen-robotics.com/reachy-mini/) with system telemetry, AI conversation, real-time vision, music playback, and full robot control.
|
| 302 |
|
| 303 |
Built on the `reachy-mini` SDK as a `ReachyMiniApp`. Serves a single-page web UI on port 8042.
|
| 304 |
|
|
|
|
|
|
|
| 305 |
```mermaid
|
| 306 |
graph LR
|
| 307 |
subgraph Browser
|
|
@@ -673,7 +1317,7 @@ hello_world/
|
|
| 673 |
β βββ status-manager.js # Service health pills + issue badge
|
| 674 |
β βββ transcribe.js # Transcript WebSocket UI + message routing
|
| 675 |
β βββ vision.js # Vision mode/task/settings controller
|
| 676 |
-
β βββ vision-follow.js # Vision-based head tracking (follow
|
| 677 |
β βββ vision-overlay.js # Canvas overlay (boxes, keypoints, labels)
|
| 678 |
β βββ vision-poses.js # Pose keypoint visualization + skeleton rendering
|
| 679 |
β βββ vision-webgpu.js # Browser-side ONNX Runtime Web inference
|
|
@@ -1000,137 +1644,7 @@ Dark/light theme via CSS custom properties. Toggle in header bar. Persisted to l
|
|
| 1000 |
## License
|
| 1001 |
|
| 1002 |
Community project for Reachy Mini developers.
|
| 1003 |
-
|
| 1004 |
</script>
|
| 1005 |
|
| 1006 |
-
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
|
| 1007 |
-
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
|
| 1008 |
-
|
| 1009 |
-
<script>
|
| 1010 |
-
mermaid.initialize({
|
| 1011 |
-
startOnLoad: false,
|
| 1012 |
-
theme: "dark",
|
| 1013 |
-
themeVariables: {
|
| 1014 |
-
primaryColor: "#7c5cfc",
|
| 1015 |
-
primaryTextColor: "#e2e0ea",
|
| 1016 |
-
primaryBorderColor: "#1e1e2e",
|
| 1017 |
-
lineColor: "#7c5cfc",
|
| 1018 |
-
secondaryColor: "#14141f",
|
| 1019 |
-
tertiaryColor: "#111118",
|
| 1020 |
-
background: "#14141f",
|
| 1021 |
-
mainBkg: "#14141f",
|
| 1022 |
-
nodeBorder: "#7c5cfc"
|
| 1023 |
-
}
|
| 1024 |
-
});
|
| 1025 |
-
|
| 1026 |
-
// Render
|
| 1027 |
-
const md = document.getElementById("md-src").textContent;
|
| 1028 |
-
const renderer = new marked.Renderer();
|
| 1029 |
-
|
| 1030 |
-
renderer.code = function({ text, lang }) {
|
| 1031 |
-
if (lang === "mermaid") return '<div class="mermaid">' + text + "</div>";
|
| 1032 |
-
const esc = text.replace(/</g,"<").replace(/>/g,">");
|
| 1033 |
-
return '<pre><code class="language-' + (lang||"") + '">' + esc + "</code></pre>";
|
| 1034 |
-
};
|
| 1035 |
-
|
| 1036 |
-
renderer.heading = function({ text, depth }) {
|
| 1037 |
-
const id = text.toLowerCase().replace(/[^\w]+/g, "-").replace(/-+$/, "");
|
| 1038 |
-
return "<h" + depth + ' id="' + id + '">' + text + "</h" + depth + ">";
|
| 1039 |
-
};
|
| 1040 |
-
|
| 1041 |
-
marked.setOptions({ renderer, gfm: true, breaks: false });
|
| 1042 |
-
|
| 1043 |
-
const docsEl = document.getElementById("docs");
|
| 1044 |
-
docsEl.innerHTML = marked.parse(md);
|
| 1045 |
-
mermaid.run({ nodes: document.querySelectorAll(".mermaid") });
|
| 1046 |
-
|
| 1047 |
-
// TOC
|
| 1048 |
-
const tocPanel = document.getElementById("tocPanel");
|
| 1049 |
-
docsEl.querySelectorAll("h1,h2,h3").forEach(h => {
|
| 1050 |
-
if (!h.id) return;
|
| 1051 |
-
const a = document.createElement("a");
|
| 1052 |
-
a.href = "#" + h.id;
|
| 1053 |
-
a.textContent = h.textContent;
|
| 1054 |
-
if (h.tagName === "H3") a.className = "depth-3";
|
| 1055 |
-
a.onclick = () => tocPanel.classList.remove("open");
|
| 1056 |
-
tocPanel.appendChild(a);
|
| 1057 |
-
});
|
| 1058 |
-
|
| 1059 |
-
document.getElementById("tocBtn").onclick = () => tocPanel.classList.toggle("open");
|
| 1060 |
-
document.addEventListener("click", e => {
|
| 1061 |
-
if (!tocPanel.contains(e.target) && e.target !== document.getElementById("tocBtn"))
|
| 1062 |
-
tocPanel.classList.remove("open");
|
| 1063 |
-
});
|
| 1064 |
-
|
| 1065 |
-
// Back to top
|
| 1066 |
-
const topBtn = document.getElementById("topBtn");
|
| 1067 |
-
window.addEventListener("scroll", () => topBtn.classList.toggle("show", scrollY > 400));
|
| 1068 |
-
|
| 1069 |
-
// Search
|
| 1070 |
-
const searchInput = document.getElementById("search");
|
| 1071 |
-
const searchInfo = document.getElementById("searchInfo");
|
| 1072 |
-
let searchTimer;
|
| 1073 |
-
searchInput.addEventListener("input", () => { clearTimeout(searchTimer); searchTimer = setTimeout(doSearch, 200); });
|
| 1074 |
-
|
| 1075 |
-
function doSearch() {
|
| 1076 |
-
const q = searchInput.value.trim().toLowerCase();
|
| 1077 |
-
|
| 1078 |
-
// Clear highlights
|
| 1079 |
-
docsEl.querySelectorAll("mark").forEach(m => {
|
| 1080 |
-
const p = m.parentNode;
|
| 1081 |
-
p.replaceChild(document.createTextNode(m.textContent), m);
|
| 1082 |
-
p.normalize();
|
| 1083 |
-
});
|
| 1084 |
-
docsEl.querySelectorAll(".search-hidden").forEach(el => el.classList.remove("search-hidden"));
|
| 1085 |
-
|
| 1086 |
-
if (!q) { searchInfo.textContent = ""; return; }
|
| 1087 |
-
|
| 1088 |
-
// Group into sections by h1/h2
|
| 1089 |
-
const sections = [];
|
| 1090 |
-
let cur = null;
|
| 1091 |
-
for (const child of docsEl.children) {
|
| 1092 |
-
if (child.tagName === "H1" || child.tagName === "H2") {
|
| 1093 |
-
cur = { heading: child, els: [child] };
|
| 1094 |
-
sections.push(cur);
|
| 1095 |
-
} else if (cur) {
|
| 1096 |
-
cur.els.push(child);
|
| 1097 |
-
}
|
| 1098 |
-
}
|
| 1099 |
-
|
| 1100 |
-
let count = 0;
|
| 1101 |
-
sections.forEach(sec => {
|
| 1102 |
-
const text = sec.els.map(e => e.textContent).join(" ").toLowerCase();
|
| 1103 |
-
if (!text.includes(q)) {
|
| 1104 |
-
sec.els.forEach(e => e.classList.add("search-hidden"));
|
| 1105 |
-
} else {
|
| 1106 |
-
sec.els.forEach(e => { count += highlight(e, q); });
|
| 1107 |
-
}
|
| 1108 |
-
});
|
| 1109 |
-
|
| 1110 |
-
searchInfo.textContent = count > 0 ? count + " match" + (count === 1 ? "" : "es") : "No matches";
|
| 1111 |
-
}
|
| 1112 |
-
|
| 1113 |
-
function highlight(el, q) {
|
| 1114 |
-
let n = 0;
|
| 1115 |
-
if (el.classList && (el.classList.contains("mermaid") || el.tagName === "PRE")) return 0;
|
| 1116 |
-
const walker = document.createTreeWalker(el, NodeFilter.SHOW_TEXT);
|
| 1117 |
-
const nodes = [];
|
| 1118 |
-
while (walker.nextNode()) nodes.push(walker.currentNode);
|
| 1119 |
-
nodes.forEach(node => {
|
| 1120 |
-
const idx = node.textContent.toLowerCase().indexOf(q);
|
| 1121 |
-
if (idx === -1 || node.parentNode.tagName === "MARK") return;
|
| 1122 |
-
const before = document.createTextNode(node.textContent.substring(0, idx));
|
| 1123 |
-
const mark = document.createElement("mark");
|
| 1124 |
-
mark.textContent = node.textContent.substring(idx, idx + q.length);
|
| 1125 |
-
const after = document.createTextNode(node.textContent.substring(idx + q.length));
|
| 1126 |
-
node.parentNode.insertBefore(before, node);
|
| 1127 |
-
node.parentNode.insertBefore(mark, node);
|
| 1128 |
-
node.parentNode.insertBefore(after, node);
|
| 1129 |
-
node.parentNode.removeChild(node);
|
| 1130 |
-
n++;
|
| 1131 |
-
});
|
| 1132 |
-
return n;
|
| 1133 |
-
}
|
| 1134 |
-
</script>
|
| 1135 |
</body>
|
| 1136 |
-
</html>
|
|
|
|
| 5 |
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
| 6 |
<title>Documentation β Hello World DevKit</title>
|
| 7 |
<style>
|
| 8 |
+
/* ===== Theme variables (matching app dark theme) ===== */
|
| 9 |
:root {
|
| 10 |
+
--bg-primary: #0f0f0f;
|
| 11 |
+
--bg-secondary: #1a1a1a;
|
| 12 |
+
--bg-tertiary: #252525;
|
| 13 |
+
--bg-elevated: #1a1a2e;
|
| 14 |
+
--text-primary: #f5f5f5;
|
| 15 |
+
--text-secondary: #a0a0a0;
|
| 16 |
+
--text-muted: #888;
|
| 17 |
+
--accent: #6366f1;
|
| 18 |
+
--accent-hover: #818cf8;
|
| 19 |
+
--accent-20: rgba(99, 102, 241, 0.2);
|
| 20 |
+
--success: #22c55e;
|
| 21 |
+
--warning: #f59e0b;
|
| 22 |
+
--error: #ef4444;
|
| 23 |
+
--border: #333;
|
| 24 |
+
--border-subtle: #2a2a2a;
|
| 25 |
+
--radius-sm: 4px;
|
| 26 |
+
--radius-md: 6px;
|
| 27 |
+
--radius-lg: 8px;
|
| 28 |
+
--radius-xl: 12px;
|
| 29 |
}
|
| 30 |
|
| 31 |
* { margin: 0; padding: 0; box-sizing: border-box; }
|
| 32 |
|
| 33 |
body {
|
| 34 |
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
|
| 35 |
+
background: var(--bg-primary);
|
| 36 |
+
color: var(--text-primary);
|
| 37 |
+
line-height: 1.6;
|
| 38 |
}
|
| 39 |
|
| 40 |
+
/* ===== Top bar ===== */
|
| 41 |
.topbar {
|
| 42 |
position: sticky;
|
| 43 |
top: 0;
|
| 44 |
z-index: 100;
|
| 45 |
+
background: rgba(15, 15, 15, 0.92);
|
| 46 |
backdrop-filter: blur(12px);
|
| 47 |
+
border-bottom: 1px solid var(--border);
|
| 48 |
padding: 10px 20px;
|
| 49 |
display: flex;
|
| 50 |
align-items: center;
|
| 51 |
+
gap: 14px;
|
| 52 |
}
|
| 53 |
.topbar-brand {
|
| 54 |
font-weight: 700;
|
| 55 |
+
color: var(--accent-hover);
|
| 56 |
font-size: 14px;
|
| 57 |
white-space: nowrap;
|
| 58 |
text-decoration: none;
|
| 59 |
}
|
| 60 |
.topbar-brand:hover { color: #fff; }
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 61 |
.topbar-home {
|
| 62 |
color: var(--text-muted);
|
| 63 |
text-decoration: none;
|
| 64 |
font-size: 13px;
|
| 65 |
padding: 5px 12px;
|
| 66 |
+
border-radius: var(--radius-md);
|
| 67 |
border: 1px solid var(--border);
|
| 68 |
transition: all 0.2s;
|
| 69 |
white-space: nowrap;
|
| 70 |
+
margin-left: auto;
|
| 71 |
}
|
| 72 |
+
.topbar-home:hover { color: var(--accent-hover); border-color: var(--accent); }
|
| 73 |
|
| 74 |
+
/* ===== Help container (matches app layout) ===== */
|
| 75 |
+
.help-container {
|
| 76 |
+
max-width: 860px;
|
| 77 |
margin: 0 auto;
|
| 78 |
+
padding: 0 20px 80px;
|
| 79 |
+
display: flex;
|
| 80 |
+
flex-direction: column;
|
| 81 |
+
min-height: calc(100vh - 50px);
|
| 82 |
}
|
| 83 |
|
| 84 |
+
/* ===== Mode toggle ===== */
|
| 85 |
+
.help-tab-header {
|
| 86 |
+
display: flex;
|
| 87 |
+
align-items: center;
|
| 88 |
+
gap: 1rem;
|
| 89 |
+
padding: 0.75rem 0;
|
| 90 |
+
flex-shrink: 0;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 91 |
}
|
| 92 |
+
.help-mode-toggle {
|
| 93 |
+
display: flex;
|
| 94 |
+
gap: 2px;
|
| 95 |
+
background: var(--bg-tertiary);
|
| 96 |
+
border-radius: var(--radius-md);
|
| 97 |
+
padding: 2px;
|
| 98 |
}
|
| 99 |
+
.help-mode-btn {
|
| 100 |
+
background: none;
|
| 101 |
+
border: none;
|
| 102 |
+
color: var(--text-muted);
|
| 103 |
+
font-size: 0.78rem;
|
| 104 |
+
padding: 0.3rem 0.75rem;
|
| 105 |
+
border-radius: var(--radius-sm);
|
| 106 |
+
cursor: pointer;
|
| 107 |
+
transition: all 0.15s;
|
| 108 |
+
white-space: nowrap;
|
| 109 |
}
|
| 110 |
+
.help-mode-btn.active {
|
| 111 |
+
background: var(--accent);
|
| 112 |
+
color: white;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 113 |
}
|
| 114 |
+
.help-mode-btn:hover:not(.active) { color: var(--text-primary); }
|
| 115 |
|
| 116 |
+
/* ===== Search ===== */
|
| 117 |
+
.help-search-row { padding: 0 0 0.5rem; flex-shrink: 0; }
|
| 118 |
+
.help-search {
|
| 119 |
width: 100%;
|
| 120 |
+
padding: 0.5rem 0.75rem;
|
|
|
|
|
|
|
|
|
|
|
|
|
| 121 |
background: var(--bg-secondary);
|
|
|
|
|
|
|
| 122 |
border: 1px solid var(--border);
|
| 123 |
+
border-radius: var(--radius-md);
|
| 124 |
+
color: var(--text-primary);
|
| 125 |
+
font-size: 0.82rem;
|
| 126 |
+
outline: none;
|
| 127 |
+
transition: border-color 0.15s;
|
| 128 |
+
}
|
| 129 |
+
.help-search:focus { border-color: var(--accent); }
|
| 130 |
+
.help-search::placeholder { color: var(--text-muted); }
|
| 131 |
+
|
| 132 |
+
/* ===== Category pills ===== */
|
| 133 |
+
.help-categories {
|
| 134 |
+
display: flex;
|
| 135 |
+
gap: 0.35rem;
|
| 136 |
+
padding: 0 0 0.75rem;
|
| 137 |
+
flex-shrink: 0;
|
| 138 |
+
flex-wrap: wrap;
|
| 139 |
+
}
|
| 140 |
+
.help-category {
|
| 141 |
+
background: var(--bg-tertiary);
|
| 142 |
+
border: 1px solid var(--border-subtle);
|
| 143 |
+
border-radius: 999px;
|
| 144 |
+
color: var(--text-secondary);
|
| 145 |
+
font-size: 0.72rem;
|
| 146 |
+
padding: 0.2rem 0.6rem;
|
| 147 |
+
cursor: pointer;
|
| 148 |
+
transition: all 0.15s;
|
| 149 |
+
white-space: nowrap;
|
| 150 |
+
}
|
| 151 |
+
.help-category.active {
|
| 152 |
+
background: var(--accent);
|
| 153 |
+
color: white;
|
| 154 |
+
border-color: var(--accent);
|
| 155 |
+
}
|
| 156 |
+
.help-category:hover:not(.active) {
|
| 157 |
+
border-color: var(--text-muted);
|
| 158 |
+
color: var(--text-primary);
|
| 159 |
+
}
|
| 160 |
+
.help-category-count {
|
| 161 |
+
opacity: 0.6;
|
| 162 |
+
font-size: 0.65rem;
|
| 163 |
+
margin-left: 0.15rem;
|
| 164 |
+
}
|
| 165 |
+
|
| 166 |
+
/* ===== Section headers ===== */
|
| 167 |
+
.help-section-header {
|
| 168 |
+
font-size: 0.75rem;
|
| 169 |
font-weight: 600;
|
| 170 |
+
color: var(--accent);
|
| 171 |
+
text-transform: uppercase;
|
| 172 |
+
letter-spacing: 0.05em;
|
| 173 |
+
margin: 1.25rem 0 0.5rem;
|
| 174 |
+
padding-bottom: 0.25rem;
|
| 175 |
+
border-bottom: 1px solid var(--border-subtle);
|
| 176 |
}
|
| 177 |
+
.help-section-header:first-child { margin-top: 0; }
|
| 178 |
+
|
| 179 |
+
/* ===== Topic cards ===== */
|
| 180 |
+
.help-topic {
|
| 181 |
+
border: 1px solid var(--border-subtle);
|
| 182 |
+
border-radius: var(--radius-md);
|
| 183 |
+
margin-bottom: 0.4rem;
|
| 184 |
+
transition: border-color 0.15s;
|
| 185 |
}
|
| 186 |
+
.help-topic[open] { border-color: var(--accent-20); }
|
| 187 |
+
.help-topic summary {
|
| 188 |
+
cursor: pointer;
|
| 189 |
+
padding: 0.6rem 0.85rem;
|
| 190 |
+
display: flex;
|
| 191 |
+
flex-direction: column;
|
| 192 |
+
gap: 0.15rem;
|
| 193 |
+
list-style: none;
|
|
|
|
|
|
|
| 194 |
}
|
| 195 |
+
.help-topic summary::-webkit-details-marker { display: none; }
|
| 196 |
+
.help-topic summary::before { content: ''; display: none; }
|
| 197 |
+
.help-topic-title {
|
| 198 |
+
font-weight: 600;
|
| 199 |
+
font-size: 0.82rem;
|
| 200 |
+
color: var(--text-primary);
|
| 201 |
+
}
|
| 202 |
+
.help-topic-summary {
|
| 203 |
+
font-size: 0.75rem;
|
| 204 |
+
color: var(--text-muted);
|
| 205 |
+
line-height: 1.4;
|
| 206 |
+
}
|
| 207 |
+
.help-topic[open] .help-topic-title { color: var(--accent); }
|
| 208 |
+
.help-topic-snippet {
|
| 209 |
+
font-size: 0.72rem;
|
| 210 |
+
color: var(--text-muted);
|
| 211 |
+
line-height: 1.4;
|
| 212 |
+
margin-top: 0.2rem;
|
| 213 |
+
padding: 0.25rem 0.5rem;
|
| 214 |
+
background: var(--bg-secondary);
|
| 215 |
+
border-radius: var(--radius-sm);
|
| 216 |
+
border-left: 2px solid var(--accent-20);
|
| 217 |
+
font-style: italic;
|
| 218 |
+
}
|
| 219 |
+
|
| 220 |
+
/* ===== Topic body (rendered markdown) ===== */
|
| 221 |
+
.help-topic-body {
|
| 222 |
+
padding: 0 0.85rem 0.75rem;
|
| 223 |
+
font-size: 0.8rem;
|
| 224 |
+
line-height: 1.65;
|
| 225 |
+
color: var(--text-primary);
|
| 226 |
+
}
|
| 227 |
+
.help-topic-body p { margin: 0.4rem 0; }
|
| 228 |
+
.help-topic-body ul, .help-topic-body ol {
|
| 229 |
+
margin: 0.3rem 0;
|
| 230 |
+
padding-left: 1.25rem;
|
| 231 |
+
}
|
| 232 |
+
.help-topic-body li { margin: 0.15rem 0; }
|
| 233 |
+
.help-topic-body strong { color: var(--text-primary); }
|
| 234 |
+
.help-topic-body code {
|
| 235 |
+
font-family: 'SF Mono', 'Fira Code', monospace;
|
| 236 |
+
font-size: 0.75rem;
|
| 237 |
+
background: var(--bg-tertiary);
|
| 238 |
+
padding: 0.1rem 0.3rem;
|
| 239 |
+
border-radius: 3px;
|
| 240 |
+
color: var(--accent);
|
| 241 |
+
}
|
| 242 |
+
.help-topic-body pre {
|
| 243 |
+
background: var(--bg-secondary);
|
| 244 |
border: 1px solid var(--border);
|
| 245 |
+
border-radius: var(--radius-md);
|
| 246 |
+
padding: 0.6rem 0.8rem;
|
| 247 |
+
overflow-x: auto;
|
| 248 |
+
margin: 0.5rem 0;
|
| 249 |
}
|
| 250 |
+
.help-topic-body pre code {
|
| 251 |
background: none;
|
| 252 |
padding: 0;
|
| 253 |
+
color: var(--text-primary);
|
|
|
|
| 254 |
}
|
| 255 |
|
| 256 |
+
/* ===== Tags ===== */
|
| 257 |
+
.help-tags {
|
| 258 |
+
display: flex;
|
| 259 |
+
gap: 0.25rem;
|
| 260 |
+
flex-wrap: wrap;
|
| 261 |
+
padding: 0 0.85rem 0.5rem;
|
| 262 |
+
}
|
| 263 |
+
.help-tag {
|
| 264 |
+
background: var(--bg-tertiary);
|
| 265 |
+
color: var(--text-muted);
|
| 266 |
+
font-size: 0.62rem;
|
| 267 |
+
padding: 0.1rem 0.4rem;
|
| 268 |
+
border-radius: 999px;
|
| 269 |
+
letter-spacing: 0.02em;
|
| 270 |
+
}
|
| 271 |
|
| 272 |
+
/* ===== Empty/highlight ===== */
|
| 273 |
+
.help-empty {
|
| 274 |
+
text-align: center;
|
| 275 |
+
color: var(--text-muted);
|
| 276 |
+
padding: 3rem;
|
| 277 |
+
font-size: 0.85rem;
|
| 278 |
+
}
|
| 279 |
+
.help-highlight {
|
| 280 |
+
background: rgba(250, 204, 21, 0.3);
|
| 281 |
color: inherit;
|
| 282 |
border-radius: 2px;
|
| 283 |
+
padding: 0 1px;
|
| 284 |
}
|
| 285 |
+
|
| 286 |
+
/* ===== Developer Docs (README) ===== */
|
| 287 |
+
.help-dev-docs {
|
| 288 |
+
padding: 0.5rem 0;
|
| 289 |
+
line-height: 1.6;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 290 |
}
|
| 291 |
+
.help-dev-docs h1, .help-dev-docs h2, .help-dev-docs h3 {
|
| 292 |
+
color: var(--text-primary);
|
| 293 |
+
margin-top: 1.5rem;
|
| 294 |
+
}
|
| 295 |
+
.help-dev-docs h1 {
|
| 296 |
+
font-size: 1.7rem;
|
| 297 |
+
padding-bottom: 6px;
|
| 298 |
+
border-bottom: 2px solid var(--accent);
|
| 299 |
+
}
|
| 300 |
+
.help-dev-docs h1:first-child { margin-top: 0; }
|
| 301 |
+
.help-dev-docs h2 {
|
| 302 |
+
font-size: 1.3rem;
|
| 303 |
+
padding-bottom: 4px;
|
| 304 |
+
border-bottom: 1px solid var(--border);
|
| 305 |
+
color: var(--accent-hover);
|
| 306 |
+
}
|
| 307 |
+
.help-dev-docs h3 {
|
| 308 |
+
font-size: 1.05rem;
|
| 309 |
+
color: #06b6d4;
|
| 310 |
+
}
|
| 311 |
+
.help-dev-docs p { margin: 0.5rem 0; }
|
| 312 |
+
.help-dev-docs a { color: var(--accent); }
|
| 313 |
+
.help-dev-docs a:hover { text-decoration: underline; }
|
| 314 |
+
.help-dev-docs ul, .help-dev-docs ol { margin: 0.5rem 0; padding-left: 1.5rem; }
|
| 315 |
+
.help-dev-docs li { margin: 0.2rem 0; }
|
| 316 |
+
.help-dev-docs strong { color: var(--text-primary); }
|
| 317 |
+
.help-dev-docs blockquote {
|
| 318 |
+
border-left: 3px solid var(--accent);
|
| 319 |
+
padding: 8px 16px;
|
| 320 |
+
margin: 14px 0;
|
| 321 |
+
background: var(--bg-secondary);
|
| 322 |
+
border-radius: 0 8px 8px 0;
|
| 323 |
+
}
|
| 324 |
+
.help-dev-docs pre {
|
| 325 |
+
background: var(--bg-secondary);
|
| 326 |
border: 1px solid var(--border);
|
| 327 |
+
border-radius: var(--radius-md);
|
| 328 |
+
padding: 0.6rem 0.8rem;
|
| 329 |
+
overflow-x: auto;
|
| 330 |
+
margin: 0.5rem 0;
|
| 331 |
}
|
| 332 |
+
.help-dev-docs pre code {
|
| 333 |
+
background: none;
|
| 334 |
+
padding: 0;
|
| 335 |
+
color: var(--text-primary);
|
| 336 |
+
font-family: 'SF Mono', 'Fira Code', monospace;
|
| 337 |
+
font-size: 0.82rem;
|
| 338 |
+
}
|
| 339 |
+
.help-dev-docs :not(pre) > code {
|
| 340 |
+
background: var(--bg-tertiary);
|
| 341 |
+
padding: 0.1rem 0.3rem;
|
| 342 |
+
border-radius: 3px;
|
| 343 |
+
font-size: 0.75rem;
|
| 344 |
+
color: var(--accent);
|
| 345 |
+
}
|
| 346 |
+
.help-dev-docs table {
|
| 347 |
+
width: 100%;
|
| 348 |
+
border-collapse: collapse;
|
| 349 |
+
margin: 0.75rem 0;
|
| 350 |
+
font-size: 0.82rem;
|
| 351 |
}
|
| 352 |
+
.help-dev-docs th {
|
| 353 |
+
background: var(--bg-secondary);
|
| 354 |
+
padding: 8px 10px;
|
| 355 |
+
text-align: left;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 356 |
border: 1px solid var(--border);
|
| 357 |
+
font-weight: 600;
|
| 358 |
+
color: var(--accent-hover);
|
| 359 |
+
}
|
| 360 |
+
.help-dev-docs td {
|
| 361 |
+
padding: 6px 10px;
|
| 362 |
+
border: 1px solid var(--border);
|
| 363 |
+
vertical-align: top;
|
| 364 |
+
}
|
| 365 |
+
.help-dev-docs tr:nth-child(even) td { background: rgba(26, 26, 26, 0.5); }
|
| 366 |
+
.help-dev-docs hr { border: none; border-top: 1px solid var(--border); margin: 24px 0; }
|
| 367 |
+
|
| 368 |
+
/* Mermaid */
|
| 369 |
+
.help-mermaid { margin: 18px 0; text-align: center; }
|
| 370 |
+
.help-mermaid-error { color: var(--error); font-size: 0.8rem; }
|
| 371 |
+
|
| 372 |
+
/* ===== Help body scrollable area ===== */
|
| 373 |
+
.help-tab-body {
|
| 374 |
+
flex: 1;
|
| 375 |
+
overflow-y: auto;
|
| 376 |
}
|
|
|
|
| 377 |
|
| 378 |
+
/* ===== Footer ===== */
|
| 379 |
.foot {
|
| 380 |
text-align: center;
|
| 381 |
padding: 24px;
|
| 382 |
color: var(--text-muted);
|
| 383 |
font-size: 12px;
|
| 384 |
border-top: 1px solid var(--border);
|
| 385 |
+
margin-top: 40px;
|
| 386 |
+
}
|
| 387 |
+
.foot a { color: var(--accent-hover); text-decoration: none; }
|
| 388 |
+
.foot a:hover { text-decoration: underline; }
|
| 389 |
+
|
| 390 |
+
/* ===== Topic count badge ===== */
|
| 391 |
+
.topic-count {
|
| 392 |
+
color: var(--text-muted);
|
| 393 |
+
font-size: 0.72rem;
|
| 394 |
+
margin-left: auto;
|
| 395 |
}
|
|
|
|
| 396 |
|
| 397 |
@media (max-width: 768px) {
|
| 398 |
+
.help-container { padding: 0 12px 60px; }
|
| 399 |
+
.topbar { flex-wrap: wrap; gap: 8px; padding: 8px 12px; }
|
|
|
|
|
|
|
| 400 |
}
|
| 401 |
</style>
|
| 402 |
</head>
|
|
|
|
| 404 |
|
| 405 |
<div class="topbar">
|
| 406 |
<a href="index.html" class="topbar-brand">Hello World DevKit</a>
|
|
|
|
|
|
|
| 407 |
<a href="index.html" class="topbar-home">← Home</a>
|
| 408 |
</div>
|
| 409 |
|
| 410 |
+
<div class="help-container">
|
| 411 |
+
<div class="help-tab-header">
|
| 412 |
+
<div class="help-mode-toggle">
|
| 413 |
+
<button class="help-mode-btn active" data-mode="help" id="modeHelp">Quick Help</button>
|
| 414 |
+
<button class="help-mode-btn" data-mode="dev" id="modeDev">Developer Docs</button>
|
| 415 |
+
</div>
|
| 416 |
+
<span class="topic-count" id="topicCount"></span>
|
| 417 |
+
</div>
|
| 418 |
+
|
| 419 |
+
<div class="help-search-row" id="searchRow">
|
| 420 |
+
<input type="text" class="help-search" id="helpSearch" placeholder="Search help topics..." autocomplete="off" />
|
| 421 |
+
</div>
|
| 422 |
|
| 423 |
+
<div class="help-categories" id="helpCategories"></div>
|
| 424 |
+
|
| 425 |
+
<div class="help-tab-body" id="helpTabBody"></div>
|
| 426 |
+
</div>
|
| 427 |
|
| 428 |
<div class="foot">
|
| 429 |
Built with vanilla Python + JS — no framework, no bundler<br>
|
|
|
|
| 432 |
<a href="https://www.pollen-robotics.com/reachy-mini/">Reachy Mini</a>
|
| 433 |
</div>
|
| 434 |
|
| 435 |
+
<!-- Pre-baked help topics (27 conceptual topics from help.py) -->
|
| 436 |
+
<script id="topics-data" type="application/json">
|
| 437 |
+
[
|
| 438 |
+
{
|
| 439 |
+
"id": "what-is-hello-world",
|
| 440 |
+
"category": "Getting Started",
|
| 441 |
+
"title": "What is Hello World?",
|
| 442 |
+
"summary": "A community dashboard for Reachy Mini with AI conversation, vision, and motion control.",
|
| 443 |
+
"body": "Hello World is an open-source web dashboard for **Reachy Mini**, a small expressive robot head by Pollen Robotics. It runs directly on Reachy's onboard Raspberry Pi CM4 and provides:\n\n- **Voice conversation** with AI (multi-provider: OpenAI, Anthropic, Google, Groq, Ollama, and more)\n- **Real-time vision** with YOLO object detection, pose estimation, and segmentation\n- **81 emotions** and **19 dances** for expressive robot behavior\n- **MuJoCo 3D simulation** of the robot head\n- **Timers, alarms, and ambient sounds** with custom sound upload\n- **Music playback**, snapshots, video/audio recording\n- **Joystick control** for manual head movement\n\nAccess the dashboard at `http://reachy:8042` from any device on the same network.",
|
| 444 |
+
"tags": ["overview", "introduction", "about", "dashboard"]
|
| 445 |
+
},
|
| 446 |
+
{
|
| 447 |
+
"id": "dashboard-tabs",
|
| 448 |
+
"category": "Getting Started",
|
| 449 |
+
"title": "Dashboard Tabs Overview",
|
| 450 |
+
"summary": "Navigate the main tabs: Status, Telemetry, Moves, Conversation, Media, Timers, Settings.",
|
| 451 |
+
"body": "The dashboard has several tabs across the top:\n\n- **Status** \u2014 System stats (CPU, RAM, disk, network), uptime, head telemetry\n- **Telemetry** \u2014 Real-time charts of system metrics\n- **Moves** \u2014 Gallery of 81 emotions, 19 dances, and 6 oscillation patterns with preview\n- **Conversation** \u2014 Voice transcription, AI chat, and listener controls\n- **Media** \u2014 Recordings, snapshots, music library\n- **Timers** \u2014 Countdown timers, alarms, and ambient sound playback\n- **Settings** \u2014 API keys, audio, vision, UI configuration\n\nClick any tab to switch. Your last active tab is remembered across sessions.",
|
| 452 |
+
"tags": ["tabs", "navigation", "ui", "layout"]
|
| 453 |
+
},
|
| 454 |
+
{
|
| 455 |
+
"id": "api-keys-setup",
|
| 456 |
+
"category": "Getting Started",
|
| 457 |
+
"title": "Setting Up AI Providers",
|
| 458 |
+
"summary": "Add API keys for OpenAI, Anthropic, Google, Groq, or connect to local Ollama.",
|
| 459 |
+
"body": "To use AI features (voice conversation, vision analysis), you need at least one AI provider key:\n\n1. Go to **Settings** tab\n2. Find the **API Keys** section\n3. Enter your key for any supported provider\n4. The system auto-detects which capabilities each provider offers (LLM, STT, TTS, VLM)\n\n**Supported providers**: OpenAI, Anthropic, Google (Gemini), Groq, DeepSeek, ElevenLabs, Ollama (local).\n\nFor **Ollama** (free, local models): enter the server URL (e.g. `http://localhost:11434`) instead of an API key. Ollama provides LLM and VLM capabilities without any cloud costs.\n\nKeys are stored locally in `settings.json` on the robot and never sent anywhere except the provider's API.",
|
| 460 |
+
"tags": ["api", "keys", "providers", "setup", "openai", "anthropic", "ollama", "groq"]
|
| 461 |
+
},
|
| 462 |
+
{
|
| 463 |
+
"id": "first-conversation",
|
| 464 |
+
"category": "Getting Started",
|
| 465 |
+
"title": "Your First Conversation with Reachy",
|
| 466 |
+
"summary": "Start talking to Reachy using voice or text with the AI assistant.",
|
| 467 |
+
"body": "Once you have an API key configured:\n\n1. Go to the **Conversation** tab\n2. Select your preferred **STT** (speech-to-text), **LLM** (chat), and **TTS** (text-to-speech) providers/models\n3. Click **Start Listener** to begin voice input, or type in the chat box\n4. Reachy will respond with speech and expressive head movements\n\nReachy has 24 built-in tools: playing emotions/dances, taking snapshots, setting timers, playing music, checking system status, creating visual content on the scratchpad, and more. Just ask naturally.\n\n**Tip**: Adjust the confidence and volume thresholds in Settings if Reachy responds to background noise.",
|
| 468 |
+
"tags": ["conversation", "voice", "chat", "assistant", "getting started"]
|
| 469 |
+
},
|
| 470 |
+
{
|
| 471 |
+
"id": "making-reachy-move",
|
| 472 |
+
"category": "Getting Started",
|
| 473 |
+
"title": "Making Reachy Move",
|
| 474 |
+
"summary": "Use emotions, dances, oscillation patterns, and the joystick to animate Reachy.",
|
| 475 |
+
"body": "Reachy can move in several ways:\n\n**Emotions** (81 animations): Go to the Moves tab and click any emotion card to play it. Categories include happy, sad, angry, surprised, thinking, and more.\n\n**Dances** (19 patterns): Rhythmic head movements like nodding, swaying, and bobbing.\n\n**Oscillation** (6 patterns): Continuous idle animations \u2014 sway, nod, circle, breathe, figure8, lookAround. Great for making Reachy look alive when idle.\n\n**Joystick**: Use the floating joystick panel for direct head control \u2014 5 axes (yaw, pitch, roll, body rotation, vertical).\n\n**Voice**: During conversation, Reachy automatically plays emotions matching its responses.",
|
| 476 |
+
"tags": ["movement", "emotions", "dances", "oscillation", "joystick", "animation"]
|
| 477 |
+
},
|
| 478 |
+
{
|
| 479 |
+
"id": "floating-panels",
|
| 480 |
+
"category": "Getting Started",
|
| 481 |
+
"title": "Floating Panels",
|
| 482 |
+
"summary": "Camera view and joystick controls as draggable floating windows.",
|
| 483 |
+
"body": "Two panels can float on top of any tab:\n\n- **Camera Panel** \u2014 Live video feed from Reachy's camera or MuJoCo simulation. Toggle between camera, simulation, both, or off in Settings.\n- **Joystick Panel** \u2014 5-axis head control with a virtual joystick. Controls yaw (left/right), pitch (up/down), roll (tilt), body rotation, and vertical position.\n\nBoth panels are draggable, resizable, and remember their position across sessions.",
|
| 484 |
+
"tags": ["panels", "camera", "joystick", "floating", "ui"]
|
| 485 |
+
},
|
| 486 |
+
{
|
| 487 |
+
"id": "joystick-controls",
|
| 488 |
+
"category": "Controls",
|
| 489 |
+
"title": "Joystick Controls",
|
| 490 |
+
"summary": "5-axis head control with yaw, pitch, roll, body rotation, and vertical translation.",
|
| 491 |
+
"body": "The joystick provides 5 axes of control:\n\n- **Yaw**: Left/right rotation (-50 to +50 degrees)\n- **Pitch**: Up/down tilt (-25 to +25 degrees)\n- **Roll**: Head tilt (-30 to +35 degrees)\n- **Body Rotation**: Full body yaw (-160 to +160 degrees)\n- **Vertical (Z)**: Head height adjustment (-4cm to +4cm)\n\nThe joystick sends head pose commands via WebSocket at the configured update rate (default 15Hz). Release the joystick to return to center.",
|
| 492 |
+
"tags": ["joystick", "controls", "axes", "head", "movement"]
|
| 493 |
+
},
|
| 494 |
+
{
|
| 495 |
+
"id": "motor-modes",
|
| 496 |
+
"category": "Controls",
|
| 497 |
+
"title": "Motor Modes",
|
| 498 |
+
"summary": "Three motor modes: Enabled (full control), Disabled (limp), Gravity Compensation (springy).",
|
| 499 |
+
"body": "Reachy's motors have three modes:\n\n- **Enabled**: Full torque, robot holds position and responds to commands. Required for emotions, dances, and joystick.\n- **Disabled**: Motors are off, head is limp. Safe for physical interaction.\n- **Gravity Compensation**: Motors resist gravity but allow manual positioning. The head feels springy and can be gently moved by hand.\n\nChange modes from Settings or via the API. Motors must be **enabled** for any movement commands to work.",
|
| 500 |
+
"tags": ["motors", "mode", "enabled", "disabled", "gravity"]
|
| 501 |
+
},
|
| 502 |
+
{
|
| 503 |
+
"id": "voice-setup",
|
| 504 |
+
"category": "Voice & AI",
|
| 505 |
+
"title": "Setting Up Voice Conversation",
|
| 506 |
+
"summary": "Configure speech-to-text, LLM, and text-to-speech for voice interaction.",
|
| 507 |
+
"body": "Voice conversation requires three AI components:\n\n1. **STT (Speech-to-Text)**: Converts your speech to text. Providers: OpenAI (gpt-4o-transcribe), Groq (whisper-large-v3-turbo).\n2. **LLM (Language Model)**: Generates responses. Providers: Anthropic (Claude), OpenAI (GPT), Google (Gemini), Ollama (local), and more.\n3. **TTS (Text-to-Speech)**: Speaks responses aloud. Providers: OpenAI (gpt-4o-mini-tts), Google (Gemini TTS).\n\nConfigure each in the **Settings** tab under the Conversation section. The system routes through **LiteLLM** for unified provider access.\n\n**Language**: The `stt_language` setting controls the speech recognition language (ISO 639-1 code, e.g. `en`, `fr`, `de`). Defaults to English (`en`). Set to empty for auto-detect (multilingual mode). See the *Multilingual Support* topic for details.\n\n**Audio routing**: Choose between robot mic/speaker or browser mic/speaker for input and output independently.",
|
| 508 |
+
"tags": ["voice", "stt", "tts", "llm", "conversation", "speech", "microphone", "language"]
|
| 509 |
+
},
|
| 510 |
+
{
|
| 511 |
+
"id": "multilingual-support",
|
| 512 |
+
"category": "Voice & AI",
|
| 513 |
+
"title": "Multilingual Support",
|
| 514 |
+
"summary": "Hello World supports speech recognition in 99 languages via Whisper.",
|
| 515 |
+
"body": "The speech-to-text engine (Whisper) supports **99 languages**. By default, the `stt_language` setting is set to `en` (English) to prevent false transcriptions from background noise.\n\n**To use a different language:**\n- In Settings, change `stt_language` to an ISO 639-1 code (e.g. `fr` for French, `de` for German, `es` for Spanish, `ja` for Japanese)\n- Set it to an empty string for auto-detection (Whisper will detect the language per utterance)\n\n**Common language codes:** en (English), fr (French), de (German), es (Spanish), it (Italian), pt (Portuguese), nl (Dutch), ja (Japanese), ko (Korean), zh (Chinese), ar (Arabic), hi (Hindi), ru (Russian), pl (Polish), sv (Swedish), tr (Turkish)\n\n**Why default to English?** Without a language hint, Whisper sometimes hallucinates text in random languages when it hears ambiguous sounds or background noise. Pinning the language eliminates this.",
|
| 516 |
+
"tags": ["multilingual", "language", "stt", "whisper", "french", "german", "spanish", "i18n", "international"]
|
| 517 |
+
},
|
| 518 |
+
{
|
| 519 |
+
"id": "custom-system-prompt",
|
| 520 |
+
"category": "Voice & AI",
|
| 521 |
+
"title": "Custom System Prompts",
|
| 522 |
+
"summary": "Override Reachy's default personality and instructions with a custom system prompt.",
|
| 523 |
+
"body": "By default, Reachy uses a built-in system prompt that defines its personality and capabilities. You can override this in Settings:\n\n- Find **System Prompt** in the Conversation settings\n- Enter your custom instructions (leave empty to use the default)\n- Changes take effect on the next conversation turn\n\nThe default prompt instructs Reachy to be concise, expressive (always play emotions), and format output for TTS (no markdown, numbers as words).",
|
| 524 |
+
"tags": ["prompt", "personality", "system", "custom", "instructions"]
|
| 525 |
+
},
|
| 526 |
+
{
|
| 527 |
+
"id": "vision-modes",
|
| 528 |
+
"category": "Vision",
|
| 529 |
+
"title": "Vision Modes: CM4 vs WebGPU",
|
| 530 |
+
"summary": "Two inference backends for object detection \u2014 local Pi or browser GPU.",
|
| 531 |
+
"body": "Reachy supports two vision inference modes:\n\n**CM4 Mode** (local): Runs YOLO on the Pi's CPU via ONNX Runtime. Limited to nano models (~2-8 FPS). No extra hardware needed.\n\n**WebGPU Mode** (browser): Offloads inference to your browser's GPU via WebGPU/ONNX Web Runtime. Supports all model sizes, much faster on modern GPUs (30-60 FPS). Requires a WebGPU-capable browser.\n\nSwitch modes in Settings > Vision. CM4 mode is best for standalone operation; WebGPU mode is best when you have a laptop or desktop with a good GPU connected.",
|
| 532 |
+
"tags": ["vision", "cm4", "webgpu", "yolo", "inference", "gpu"]
|
| 533 |
+
},
|
| 534 |
+
{
|
| 535 |
+
"id": "snapshots-recordings",
|
| 536 |
+
"category": "Media",
|
| 537 |
+
"title": "Snapshots and Recordings",
|
| 538 |
+
"summary": "Capture images and record video/audio from Reachy's camera and microphone.",
|
| 539 |
+
"body": "**Snapshots**: Click the camera button or ask Reachy to take a snapshot. Images are saved to the media folder and visible in the Media tab. If a VLM is configured, snapshots are automatically described.\n\n**Video Recording**: Start/stop recording from the Robot tab or via voice command. Recordings use the robot's camera.\n\n**Audio Recording**: Record from the robot's microphone for sound capture.\n\nAll media files are accessible from the **Media** tab with thumbnails and playback controls.",
|
| 540 |
+
"tags": ["snapshot", "recording", "video", "audio", "camera", "media"]
|
| 541 |
+
},
|
| 542 |
+
{
|
| 543 |
+
"id": "music-playback",
|
| 544 |
+
"category": "Media",
|
| 545 |
+
"title": "Music Playback",
|
| 546 |
+
"summary": "Upload and play music through Reachy's speaker with volume control.",
|
| 547 |
+
"body": "Upload music files (MP3, WAV) to Reachy's music library. Play them from the Media tab or ask Reachy via voice (\"play some music\").\n\nThe AI can list available tracks and play specific ones using the `list_music` and `play_music` tools.\n\nMusic volume is controlled independently from speech volume via the `music_volume` setting. The master volume applies on top of all channels.",
|
| 548 |
+
"tags": ["music", "playback", "upload", "speaker", "audio"]
|
| 549 |
+
},
|
| 550 |
+
{
|
| 551 |
+
"id": "timers-guide",
|
| 552 |
+
"category": "Timers & Sounds",
|
| 553 |
+
"title": "Countdown Timers",
|
| 554 |
+
"summary": "Set named countdown timers that play a sound and announce when done.",
|
| 555 |
+
"body": "Set a timer from the Timers tab or by voice (\"set a timer for 5 minutes called pasta\").\n\nWhen a timer expires:\n- A configurable sound plays on the robot speaker\n- Reachy announces the timer name via TTS\n- A celebration emotion plays\n\nTimers can be paused, resumed, or cancelled. Expired/cancelled timers are auto-cleaned after 30 seconds. Timer state is in-memory (lost on restart).\n\nChoose from bundled timer sounds (ding, success, bell) or upload your own custom sounds.",
|
| 556 |
+
"tags": ["timer", "countdown", "sound", "notification"]
|
| 557 |
+
},
|
| 558 |
+
{
|
| 559 |
+
"id": "alarms-guide",
|
| 560 |
+
"category": "Timers & Sounds",
|
| 561 |
+
"title": "Alarms",
|
| 562 |
+
"summary": "Set recurring or one-shot alarms with day-of-week scheduling.",
|
| 563 |
+
"body": "Set alarms from the Timers tab or by voice (\"set an alarm for 7 AM called wake up\").\n\n**One-shot alarms**: Trigger once at the specified time, then auto-disable.\n**Recurring alarms**: Set specific days (mon, tue, etc.) to repeat weekly.\n\nWhen an alarm triggers: a sound plays, Reachy announces the alarm name, and a welcoming emotion plays.\n\nAlarms can be snoozed (default 5 minutes), dismissed, toggled on/off, or deleted. Alarm definitions persist in settings.json across restarts.",
|
| 564 |
+
"tags": ["alarm", "schedule", "recurring", "snooze", "wake"]
|
| 565 |
+
},
|
| 566 |
+
{
|
| 567 |
+
"id": "ambient-sounds",
|
| 568 |
+
"category": "Timers & Sounds",
|
| 569 |
+
"title": "Ambient Sounds",
|
| 570 |
+
"summary": "Loop ambient soundscapes (rain, ocean, forest) with optional sleep timer.",
|
| 571 |
+
"body": "Play ambient sounds from the Timers tab or by voice (\"play rain sounds for 30 minutes\").\n\n**Bundled sounds**: Rain, Ocean, Forest, Crickets, Fireplace, Wind, White Noise, Pink Noise, Brown Noise.\n\nFeatures:\n- Loops seamlessly by re-reading the audio file\n- Optional sleep timer auto-stops after N minutes\n- Pauses automatically during TTS playback (yields the speaker)\n- Volume adjustable independently via ambient_volume setting\n- Upload custom ambient loops (WAV/MP3, up to 20MB)\n\nAmbient and music share the speaker pipeline \u2014 starting one stops the other.",
|
| 572 |
+
"tags": ["ambient", "sounds", "rain", "ocean", "forest", "sleep", "noise", "loop"]
|
| 573 |
+
},
|
| 574 |
+
{
|
| 575 |
+
"id": "scratchpad-overview",
|
| 576 |
+
"category": "Media",
|
| 577 |
+
"title": "Scratchpad \u2014 Visual Content",
|
| 578 |
+
"summary": "Create rich HTML visualizations with charts, diagrams, code, and tables.",
|
| 579 |
+
"body": "The **Scratchpad** tab displays rich HTML content created by the AI or via the API. It supports:\n\n- **Chart.js** charts (bar, line, doughnut, etc.)\n- **Mermaid** diagrams (flowcharts, sequence, state, etc.)\n- **Prism** syntax-highlighted code blocks (Python, JavaScript, Bash, JSON)\n- **KaTeX** mathematical equations\n- **Markdown** rendering\n- Themed cards, badges, tables, and grid layouts\n\nContent is theme-aware \u2014 it switches between dark and light mode with the dashboard.\n\n**Entries are organized by project** and searchable by title or project name. When the AI creates a new entry, the dashboard auto-switches to the Scratchpad tab.\n\nAsk the AI to create visual content: \"Show me a chart of...\", \"Draw a diagram of...\", \"Create a comparison table for...\"",
|
| 580 |
+
"tags": ["scratchpad", "visualization", "chart", "diagram", "mermaid", "code"]
|
| 581 |
+
},
|
| 582 |
+
{
|
| 583 |
+
"id": "bluetooth-audio",
|
| 584 |
+
"category": "Controls",
|
| 585 |
+
"title": "Bluetooth Audio",
|
| 586 |
+
"summary": "Stream music and audio to Bluetooth speakers or headphones.",
|
| 587 |
+
"body": "Reachy can route audio output to Bluetooth A2DP speakers or headphones:\n\n1. **Pair a device**: Go to Settings and scan for nearby Bluetooth devices\n2. **Select audio output**: Set `audio_output` to `bluetooth` in Settings\n3. **Music streams at 48kHz** via A2DP for high quality playback\n\nWhen Bluetooth is selected, music and ambient sounds play through the Bluetooth device. Speech (TTS) can be routed to either the robot speaker or Bluetooth.\n\nThe intercom feature can also stream browser microphone audio to Bluetooth.",
|
| 588 |
+
"tags": ["bluetooth", "audio", "speaker", "a2dp", "wireless"]
|
| 589 |
+
},
|
| 590 |
+
{
|
| 591 |
+
"id": "intercom-speak-through-robot",
|
| 592 |
+
"category": "Controls",
|
| 593 |
+
"title": "Speak Through Robot (Intercom)",
|
| 594 |
+
"summary": "Use your browser mic to speak through the robot's speaker in real time.",
|
| 595 |
+
"body": "The **Speak Through Robot** button (microphone icon in the Conversation tab header) streams your browser microphone audio directly to the robot's speaker in real time.\n\nThis is different from the voice listener \u2014 the intercom does not transcribe speech. It is a direct audio pass-through, like a walkie-talkie.\n\n**How it works:**\n1. Click the microphone/speak button in the Conversation tab header\n2. Grant browser microphone permission if prompted\n3. Speak \u2014 your voice plays through the robot's speaker immediately\n4. Click again to stop\n\nThe intercom uses the `/ws/intercom` WebSocket endpoint and streams 16kHz PCM audio.",
|
| 596 |
+
"tags": ["intercom", "speak", "microphone", "speaker", "pass-through", "walkie-talkie", "browser mic"]
|
| 597 |
+
},
|
| 598 |
+
{
|
| 599 |
+
"id": "volume-channels",
|
| 600 |
+
"category": "Controls",
|
| 601 |
+
"title": "Volume Channels",
|
| 602 |
+
"summary": "Independent volume controls for master, music, speech, effects, and ambient sounds.",
|
| 603 |
+
"body": "Audio volume is controlled through multiple independent channels:\n\n- **Master Volume** (0-100, default 68): Scales all audio. Applied on top of per-channel volumes.\n- **Music Volume** (0-100, default 80): Controls music playback level.\n- **Ambient Volume** (0-100, default 15): Controls ambient sound loops (rain, ocean, etc.).\n- **Effects Volume** (0-100, default 80): Controls emotion and dance sound effects.\n- **Speech Volume** (0-100, default 80): Controls TTS voice output level.\n\nThe final volume for any source is: `master \u00d7 channel \u00d7 boost`. For example, TTS at master=68, speech=80 plays at 68% \u00d7 80% \u00d7 2.0 boost = 1.09\u00d7 normal level.\n\nAdjust all volumes in **Settings > Audio**.",
|
| 604 |
+
"tags": ["volume", "master", "music", "speech", "effects", "ambient", "audio", "level"]
|
| 605 |
+
},
|
| 606 |
+
{
|
| 607 |
+
"id": "web-search",
|
| 608 |
+
"category": "Voice & AI",
|
| 609 |
+
"title": "Web Search Model Filter",
|
| 610 |
+
"summary": "Filter the LLM model list to only show models that support web search.",
|
| 611 |
+
"body": "The **Web Search** toggle in LLM settings is a **model filter**. When enabled, the model dropdown only shows models that support web search capabilities.\n\nCurrently supported providers: **Anthropic** (Claude 3.5+) and **Perplexity**.\n\nWhen a web-search-capable model is selected and the filter is on, the system automatically passes `web_search_options` to the provider during chat completions, allowing the AI to look up current information during conversations.\n\nIf you switch the filter off, all models are shown regardless of web search support.",
|
| 612 |
+
"tags": ["web", "search", "filter", "model", "selection", "chat"]
|
| 613 |
+
},
|
| 614 |
+
{
|
| 615 |
+
"id": "confidence-thresholds",
|
| 616 |
+
"category": "Voice & AI",
|
| 617 |
+
"title": "Confidence and Volume Thresholds",
|
| 618 |
+
"summary": "Fine-tune when Reachy responds to voice input and ignores background noise.",
|
| 619 |
+
"body": "Two thresholds control voice activation:\n\n**Confidence Threshold** (`conf_threshold`, default 40): Minimum confidence percentage from the speech-to-text engine. Higher values mean the engine must be more confident the audio is speech before sending it to the LLM. Raise this if Reachy responds to non-speech sounds.\n\n**Volume Threshold** (`vol_threshold`, default 40): Minimum volume level. Audio below this is ignored. Raise this in noisy environments to filter out background noise.\n\n**Mic Gain** (`mic_gain`, default 5.0, range 1-20): Amplifies the microphone signal before processing. Increase if your voice is too quiet for the thresholds.\n\nAdjust all three in **Settings**. Start with defaults and adjust if Reachy triggers on noise or misses your speech.",
|
| 620 |
+
"tags": ["confidence", "threshold", "volume", "noise", "sensitivity", "mic", "gain", "tuning"]
|
| 621 |
+
},
|
| 622 |
+
{
|
| 623 |
+
"id": "faq-no-voice",
|
| 624 |
+
"category": "FAQ",
|
| 625 |
+
"title": "Reachy won't respond to voice",
|
| 626 |
+
"summary": "Troubleshoot voice conversation issues.",
|
| 627 |
+
"body": "If Reachy is not responding to your voice:\n\n1. **Check API keys**: Ensure you have valid keys for STT, LLM, and TTS providers in Settings.\n2. **Start the listener**: Go to Conversation tab and click Start Listener.\n3. **Check thresholds**: Lower the confidence threshold (conf_threshold) and volume threshold (vol_threshold) in Settings.\n4. **Check audio input**: Verify audio_input is set correctly (robot mic or browser mic).\n5. **Mic gain**: Increase mic_gain in Settings if the mic is too quiet.\n6. **Check the Conversation tab**: Look for transcription output \u2014 if text appears but no response, the LLM key may be invalid.",
|
| 628 |
+
"tags": ["troubleshoot", "voice", "microphone", "not working", "faq"]
|
| 629 |
+
},
|
| 630 |
+
{
|
| 631 |
+
"id": "faq-camera-not-showing",
|
| 632 |
+
"category": "FAQ",
|
| 633 |
+
"title": "Camera not showing",
|
| 634 |
+
"summary": "Troubleshoot missing camera feed.",
|
| 635 |
+
"body": "If the camera feed is not visible:\n\n1. **Check video_view setting**: Must be set to 'camera' or 'both' (not 'off' or 'simulation').\n2. **Camera hardware**: Reachy uses a Sony IMX708 CSI camera \u2014 ensure the ribbon cable is connected.\n3. **Browser camera**: If using a browser camera, grant camera permissions when prompted.\n4. **Refresh**: Hard-refresh the browser (Ctrl+Shift+R) to reconnect the video stream.",
|
| 636 |
+
"tags": ["camera", "video", "not showing", "troubleshoot", "faq"]
|
| 637 |
+
},
|
| 638 |
+
{
|
| 639 |
+
"id": "faq-motors",
|
| 640 |
+
"category": "FAQ",
|
| 641 |
+
"title": "Motors explained",
|
| 642 |
+
"summary": "Understanding motor modes and when to use each one.",
|
| 643 |
+
"body": "Reachy has 9 Dynamixel XL330 servo motors:\n- 1 body rotation motor (yaw, 160 degrees range)\n- 6 Stewart platform actuators (head position/orientation)\n- 2 antenna motors (left/right)\n\n**Enabled**: Full torque. Required for all movement commands.\n**Disabled**: No torque. Head is limp. Use when physically handling the robot.\n**Gravity Compensation**: Partial torque resists gravity. Head can be gently positioned by hand.\n\nIf motors won't enable, check the daemon status: `curl http://reachy:8000/api/daemon/status`",
|
| 644 |
+
"tags": ["motors", "servo", "torque", "mode", "faq"]
|
| 645 |
+
},
|
| 646 |
+
{
|
| 647 |
+
"id": "faq-reset",
|
| 648 |
+
"category": "FAQ",
|
| 649 |
+
"title": "How to reset everything",
|
| 650 |
+
"summary": "Reset settings, restart the app, or restart the daemon.",
|
| 651 |
+
"body": "**Reset settings**: Delete `~/hello_world/settings.json` on the robot and restart the app. This restores all defaults (you will need to re-enter API keys).\n\n**Restart the app** (quick): `curl -s -X POST http://reachy:8000/api/apps/restart-current-app`\n\n**Restart the daemon** (full): SSH into Reachy and run `reachy-restart`. After daemon restart, you MUST wake it up:\n```\ncurl -s -X POST 'http://reachy:8000/api/daemon/start?wake_up=true'\ncurl -s -X POST http://reachy:8000/api/apps/restart-current-app\n```",
|
| 652 |
+
"tags": ["reset", "restart", "settings", "daemon", "faq"]
|
| 653 |
+
}
|
| 654 |
+
]
|
| 655 |
+
</script>
|
| 656 |
+
|
| 657 |
+
<script src="https://cdn.jsdelivr.net/npm/marked@14.1.0/marked.min.js"></script>
|
| 658 |
+
<script src="https://cdn.jsdelivr.net/npm/mermaid@11.4.0/dist/mermaid.min.js"></script>
|
| 659 |
+
|
| 660 |
+
<script>
|
| 661 |
+
(function() {
|
| 662 |
+
// ===== Data =====
|
| 663 |
+
const topics = JSON.parse(document.getElementById('topics-data').textContent);
|
| 664 |
+
let activeCategory = '';
|
| 665 |
+
let searchQuery = '';
|
| 666 |
+
let showingDevDocs = false;
|
| 667 |
+
let devDocsLoaded = false;
|
| 668 |
+
|
| 669 |
+
// Derive categories from topics
|
| 670 |
+
const catMap = {};
|
| 671 |
+
topics.forEach(t => { catMap[t.category] = (catMap[t.category] || 0) + 1; });
|
| 672 |
+
const categories = Object.entries(catMap).map(([name, count]) => ({ name, count }));
|
| 673 |
+
|
| 674 |
+
// ===== Init =====
|
| 675 |
+
marked.setOptions({ breaks: false, gfm: true });
|
| 676 |
+
mermaid.initialize({
|
| 677 |
+
startOnLoad: false,
|
| 678 |
+
theme: 'dark',
|
| 679 |
+
themeVariables: {
|
| 680 |
+
primaryColor: '#6366f1', primaryTextColor: '#f5f5f5',
|
| 681 |
+
primaryBorderColor: '#444', lineColor: '#666',
|
| 682 |
+
secondaryColor: '#1a1a2e', tertiaryColor: '#252525',
|
| 683 |
+
background: '#1a1a1a', mainBkg: '#1a1a2e',
|
| 684 |
+
nodeBorder: '#6366f1', clusterBkg: '#252525',
|
| 685 |
+
clusterBorder: '#444', titleColor: '#f5f5f5',
|
| 686 |
+
edgeLabelBackground: '#1a1a1a',
|
| 687 |
+
},
|
| 688 |
+
flowchart: { htmlLabels: true, curve: 'basis' },
|
| 689 |
+
securityLevel: 'loose',
|
| 690 |
+
});
|
| 691 |
+
|
| 692 |
+
// ===== Mode toggle =====
|
| 693 |
+
document.getElementById('modeHelp').addEventListener('click', function() {
|
| 694 |
+
document.querySelectorAll('.help-mode-btn').forEach(b => b.classList.remove('active'));
|
| 695 |
+
this.classList.add('active');
|
| 696 |
+
showingDevDocs = false;
|
| 697 |
+
document.getElementById('searchRow').style.display = '';
|
| 698 |
+
document.getElementById('helpCategories').style.display = '';
|
| 699 |
+
document.getElementById('topicCount').style.display = '';
|
| 700 |
+
renderTopics();
|
| 701 |
+
});
|
| 702 |
+
|
| 703 |
+
document.getElementById('modeDev').addEventListener('click', function() {
|
| 704 |
+
document.querySelectorAll('.help-mode-btn').forEach(b => b.classList.remove('active'));
|
| 705 |
+
this.classList.add('active');
|
| 706 |
+
showingDevDocs = true;
|
| 707 |
+
document.getElementById('searchRow').style.display = 'none';
|
| 708 |
+
document.getElementById('helpCategories').style.display = 'none';
|
| 709 |
+
document.getElementById('topicCount').style.display = 'none';
|
| 710 |
+
showDevDocs();
|
| 711 |
+
});
|
| 712 |
+
|
| 713 |
+
// ===== Search =====
|
| 714 |
+
document.getElementById('helpSearch').addEventListener('input', function() {
|
| 715 |
+
searchQuery = this.value.trim();
|
| 716 |
+
renderTopics();
|
| 717 |
+
});
|
| 718 |
+
|
| 719 |
+
// ===== Categories =====
|
| 720 |
+
function renderCategories() {
|
| 721 |
+
const container = document.getElementById('helpCategories');
|
| 722 |
+
let html = '<button class="help-category active" data-cat="" title="Show all topics">All</button>';
|
| 723 |
+
for (const cat of categories) {
|
| 724 |
+
html += '<button class="help-category" data-cat="' + cat.name + '" title="Filter by ' + cat.name + '">' + cat.name + ' <span class="help-category-count">' + cat.count + '</span></button>';
|
| 725 |
+
}
|
| 726 |
+
container.innerHTML = html;
|
| 727 |
+
container.querySelectorAll('.help-category').forEach(btn => {
|
| 728 |
+
btn.addEventListener('click', function() {
|
| 729 |
+
activeCategory = this.dataset.cat;
|
| 730 |
+
container.querySelectorAll('.help-category').forEach(b => b.classList.remove('active'));
|
| 731 |
+
this.classList.add('active');
|
| 732 |
+
renderTopics();
|
| 733 |
+
});
|
| 734 |
+
});
|
| 735 |
+
}
|
| 736 |
+
|
| 737 |
+
// ===== Render topics =====
|
| 738 |
+
function renderTopics() {
|
| 739 |
+
const body = document.getElementById('helpTabBody');
|
| 740 |
+
if (showingDevDocs) return;
|
| 741 |
+
|
| 742 |
+
let filtered = topics.slice();
|
| 743 |
+
|
| 744 |
+
if (activeCategory) {
|
| 745 |
+
filtered = filtered.filter(t => t.category === activeCategory);
|
| 746 |
+
}
|
| 747 |
+
|
| 748 |
+
if (searchQuery) {
|
| 749 |
+
const words = searchQuery.toLowerCase().split(/\s+/);
|
| 750 |
+
filtered = filtered.filter(t => {
|
| 751 |
+
const text = [t.title, t.summary, (t.tags || []).join(' '), t.body || ''].join(' ').toLowerCase();
|
| 752 |
+
return words.every(w => text.includes(w));
|
| 753 |
+
});
|
| 754 |
+
filtered.sort((a, b) => {
|
| 755 |
+
const aTitle = a.title.toLowerCase();
|
| 756 |
+
const bTitle = b.title.toLowerCase();
|
| 757 |
+
const aMatch = words.some(w => aTitle.includes(w)) ? 1 : 0;
|
| 758 |
+
const bMatch = words.some(w => bTitle.includes(w)) ? 1 : 0;
|
| 759 |
+
return bMatch - aMatch;
|
| 760 |
+
});
|
| 761 |
+
}
|
| 762 |
+
|
| 763 |
+
document.getElementById('topicCount').textContent = filtered.length + ' topic' + (filtered.length === 1 ? '' : 's');
|
| 764 |
+
|
| 765 |
+
if (filtered.length === 0) {
|
| 766 |
+
body.innerHTML = '<div class="help-empty">No topics found' + (searchQuery ? ' for "' + escapeHtml(searchQuery) + '"' : '') + '.</div>';
|
| 767 |
+
return;
|
| 768 |
+
}
|
| 769 |
+
|
| 770 |
+
let html = '';
|
| 771 |
+
let currentCategory = '';
|
| 772 |
+
|
| 773 |
+
for (const topic of filtered) {
|
| 774 |
+
if (!activeCategory && !searchQuery && topic.category !== currentCategory) {
|
| 775 |
+
currentCategory = topic.category;
|
| 776 |
+
html += '<div class="help-section-header">' + currentCategory + '</div>';
|
| 777 |
+
}
|
| 778 |
+
|
| 779 |
+
const tags = (topic.tags || []).map(t =>
|
| 780 |
+
'<span class="help-tag">' + (searchQuery ? highlightText(t, searchQuery) : escapeHtml(t)) + '</span>'
|
| 781 |
+
).join('');
|
| 782 |
+
|
| 783 |
+
const titleHtml = searchQuery ? highlightText(topic.title, searchQuery) : escapeHtml(topic.title);
|
| 784 |
+
const summaryHtml = searchQuery ? highlightText(topic.summary, searchQuery) : escapeHtml(topic.summary);
|
| 785 |
+
|
| 786 |
+
let snippetHtml = '';
|
| 787 |
+
if (searchQuery) {
|
| 788 |
+
const words = searchQuery.toLowerCase().split(/\s+/).filter(w => w.length > 0);
|
| 789 |
+
const titleLower = (topic.title + ' ' + topic.summary).toLowerCase();
|
| 790 |
+
const bodyOnly = topic.body || '';
|
| 791 |
+
const bodyLower = bodyOnly.toLowerCase();
|
| 792 |
+
const bodyOnlyWords = words.filter(w => bodyLower.includes(w) && !titleLower.includes(w));
|
| 793 |
+
const anyTitleMatch = words.some(w => titleLower.includes(w));
|
| 794 |
+
if (bodyOnlyWords.length > 0 || !anyTitleMatch) {
|
| 795 |
+
const snippet = extractSnippet(bodyOnly, words);
|
| 796 |
+
if (snippet) {
|
| 797 |
+
snippetHtml = '<div class="help-topic-snippet">' + highlightText(snippet, searchQuery) + '</div>';
|
| 798 |
+
}
|
| 799 |
+
}
|
| 800 |
+
}
|
| 801 |
+
|
| 802 |
+
html += '<details class="help-topic" id="help-' + topic.id + '">' +
|
| 803 |
+
'<summary>' +
|
| 804 |
+
'<span class="help-topic-title">' + titleHtml + '</span>' +
|
| 805 |
+
'<span class="help-topic-summary">' + summaryHtml + '</span>' +
|
| 806 |
+
snippetHtml +
|
| 807 |
+
'</summary>' +
|
| 808 |
+
'<div class="help-topic-body" data-md="' + topic.id + '">' + escapeHtml(topic.body || '') + '</div>' +
|
| 809 |
+
(tags ? '<div class="help-tags">' + tags + '</div>' : '') +
|
| 810 |
+
'</details>';
|
| 811 |
+
}
|
| 812 |
+
|
| 813 |
+
body.innerHTML = html;
|
| 814 |
+
|
| 815 |
+
// Render markdown on expand
|
| 816 |
+
body.querySelectorAll('details.help-topic').forEach(details => {
|
| 817 |
+
details.addEventListener('toggle', function() {
|
| 818 |
+
if (!this.open) return;
|
| 819 |
+
const bodyDiv = this.querySelector('.help-topic-body');
|
| 820 |
+
if (bodyDiv.dataset.rendered) return;
|
| 821 |
+
bodyDiv.innerHTML = marked.parse(bodyDiv.textContent);
|
| 822 |
+
bodyDiv.dataset.rendered = 'true';
|
| 823 |
+
bodyDiv.querySelectorAll('table').forEach(t => t.classList.add('about-table'));
|
| 824 |
+
if (searchQuery) highlightDom(bodyDiv, searchQuery);
|
| 825 |
+
});
|
| 826 |
+
});
|
| 827 |
+
}
|
| 828 |
+
|
| 829 |
+
// ===== Developer Docs =====
|
| 830 |
+
async function showDevDocs() {
|
| 831 |
+
const body = document.getElementById('helpTabBody');
|
| 832 |
+
if (devDocsLoaded) return;
|
| 833 |
+
|
| 834 |
+
body.innerHTML = '<div class="help-empty">Loading developer documentation...</div>';
|
| 835 |
+
|
| 836 |
+
// README is embedded in a script tag to avoid a server round-trip
|
| 837 |
+
const readmeEl = document.getElementById('readme-src');
|
| 838 |
+
if (!readmeEl) {
|
| 839 |
+
body.innerHTML = '<div class="help-empty">README not available.</div>';
|
| 840 |
+
return;
|
| 841 |
+
}
|
| 842 |
+
|
| 843 |
+
const md = readmeEl.textContent;
|
| 844 |
+
|
| 845 |
+
const renderer = new marked.Renderer();
|
| 846 |
+
renderer.code = function({ text, lang }) {
|
| 847 |
+
if (lang === 'mermaid') return '<div class="help-mermaid">' + text + '</div>';
|
| 848 |
+
const esc = text.replace(/</g, '<').replace(/>/g, '>');
|
| 849 |
+
return '<pre><code class="language-' + (lang || '') + '">' + esc + '</code></pre>';
|
| 850 |
+
};
|
| 851 |
+
renderer.heading = function({ text, depth }) {
|
| 852 |
+
const id = text.toLowerCase().replace(/[^\w]+/g, '-').replace(/-+$/, '');
|
| 853 |
+
return '<h' + depth + ' id="' + id + '">' + text + '</h' + depth + '>';
|
| 854 |
+
};
|
| 855 |
+
|
| 856 |
+
body.innerHTML = '<div class="help-dev-docs">' + marked.parse(md, { renderer }) + '</div>';
|
| 857 |
+
|
| 858 |
+
// Render mermaid diagrams
|
| 859 |
+
const mermaidBlocks = body.querySelectorAll('.help-mermaid');
|
| 860 |
+
if (mermaidBlocks.length > 0) {
|
| 861 |
+
for (let i = 0; i < mermaidBlocks.length; i++) {
|
| 862 |
+
const block = mermaidBlocks[i];
|
| 863 |
+
try {
|
| 864 |
+
const { svg } = await mermaid.render('mermaid-' + i, block.textContent.trim());
|
| 865 |
+
block.innerHTML = svg;
|
| 866 |
+
} catch (e) {
|
| 867 |
+
block.innerHTML = '<pre class="help-mermaid-error">' + e.message + '</pre>';
|
| 868 |
+
}
|
| 869 |
+
}
|
| 870 |
+
}
|
| 871 |
+
|
| 872 |
+
devDocsLoaded = true;
|
| 873 |
+
}
|
| 874 |
+
|
| 875 |
+
// ===== Helpers =====
|
| 876 |
+
function highlightText(text, query) {
|
| 877 |
+
if (!query) return escapeHtml(text);
|
| 878 |
+
const escaped = escapeHtml(text);
|
| 879 |
+
const words = query.toLowerCase().split(/\s+/).filter(w => w.length > 0);
|
| 880 |
+
if (!words.length) return escaped;
|
| 881 |
+
const sorted = words.slice().sort((a, b) => b.length - a.length);
|
| 882 |
+
const pattern = sorted.map(w => w.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')).join('|');
|
| 883 |
+
const regex = new RegExp('(' + pattern + ')', 'gi');
|
| 884 |
+
return escaped.replace(regex, '<mark class="help-highlight">$1</mark>');
|
| 885 |
+
}
|
| 886 |
+
|
| 887 |
+
function highlightDom(container, query) {
|
| 888 |
+
if (!query || !container) return;
|
| 889 |
+
const words = query.toLowerCase().split(/\s+/).filter(w => w.length > 0);
|
| 890 |
+
if (!words.length) return;
|
| 891 |
+
const sorted = words.slice().sort((a, b) => b.length - a.length);
|
| 892 |
+
const pattern = sorted.map(w => w.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')).join('|');
|
| 893 |
+
const regex = new RegExp('(' + pattern + ')', 'gi');
|
| 894 |
+
const walker = document.createTreeWalker(container, NodeFilter.SHOW_TEXT, {
|
| 895 |
+
acceptNode: function(node) {
|
| 896 |
+
const tag = node.parentElement && node.parentElement.tagName;
|
| 897 |
+
if (tag === 'SCRIPT' || tag === 'STYLE' || tag === 'MARK') return NodeFilter.FILTER_REJECT;
|
| 898 |
+
return regex.test(node.textContent) ? NodeFilter.FILTER_ACCEPT : NodeFilter.FILTER_REJECT;
|
| 899 |
+
}
|
| 900 |
+
});
|
| 901 |
+
const nodes = [];
|
| 902 |
+
while (walker.nextNode()) nodes.push(walker.currentNode);
|
| 903 |
+
for (const node of nodes) {
|
| 904 |
+
const span = document.createElement('span');
|
| 905 |
+
span.innerHTML = node.textContent.replace(regex, '<mark class="help-highlight">$1</mark>');
|
| 906 |
+
node.parentNode.replaceChild(span, node);
|
| 907 |
+
}
|
| 908 |
+
}
|
| 909 |
+
|
| 910 |
+
function extractSnippet(body, words) {
|
| 911 |
+
const plain = body.replace(/[*_`#\[\]]/g, '').replace(/\n+/g, ' ').replace(/\s+/g, ' ');
|
| 912 |
+
const lower = plain.toLowerCase();
|
| 913 |
+
let bestPos = -1;
|
| 914 |
+
for (const w of words) {
|
| 915 |
+
const pos = lower.indexOf(w);
|
| 916 |
+
if (pos !== -1 && (bestPos === -1 || pos < bestPos)) bestPos = pos;
|
| 917 |
+
}
|
| 918 |
+
if (bestPos === -1) return '';
|
| 919 |
+
const start = Math.max(0, bestPos - 40);
|
| 920 |
+
const end = Math.min(plain.length, bestPos + 80);
|
| 921 |
+
let snippet = plain.slice(start, end).trim();
|
| 922 |
+
if (start > 0) snippet = '...' + snippet;
|
| 923 |
+
if (end < plain.length) snippet += '...';
|
| 924 |
+
return snippet;
|
| 925 |
+
}
|
| 926 |
+
|
| 927 |
+
function escapeHtml(str) {
|
| 928 |
+
const d = document.createElement('div');
|
| 929 |
+
d.textContent = str;
|
| 930 |
+
return d.innerHTML;
|
| 931 |
+
}
|
| 932 |
+
|
| 933 |
+
// ===== Boot =====
|
| 934 |
+
renderCategories();
|
| 935 |
+
renderTopics();
|
| 936 |
+
})();
|
| 937 |
+
</script>
|
| 938 |
+
|
| 939 |
+
<!-- README embedded for Developer Docs mode (frontmatter stripped) -->
|
| 940 |
+
<script id="readme-src" type="text/markdown">
|
| 941 |
# Hello World β Reachy Mini DevKit
|
| 942 |
|
| 943 |
A community dashboard app for [Reachy Mini](https://www.pollen-robotics.com/reachy-mini/) with system telemetry, AI conversation, real-time vision, music playback, and full robot control.
|
| 944 |
|
| 945 |
Built on the `reachy-mini` SDK as a `ReachyMiniApp`. Serves a single-page web UI on port 8042.
|
| 946 |
|
| 947 |
+
> **A note from the developer** β This is a solo project. I've been ambitious with the feature set β 114 endpoints, 22 LLM tools, real-time WebSocket control, vision, voice, smart home, and more β and that means there will be rough edges. If you find a bug or have a suggestion, please [open a discussion](https://huggingface.co/spaces/panny247/hello_world/discussions). I haven't had any community contributions yet but I genuinely welcome them. It's one person behind this, so expect passion, not perfection.
|
| 948 |
+
|
| 949 |
```mermaid
|
| 950 |
graph LR
|
| 951 |
subgraph Browser
|
|
|
|
| 1317 |
β βββ status-manager.js # Service health pills + issue badge
|
| 1318 |
β βββ transcribe.js # Transcript WebSocket UI + message routing
|
| 1319 |
β βββ vision.js # Vision mode/task/settings controller
|
| 1320 |
+
β βββ vision-follow.js # Vision-based head tracking (follow objects)
|
| 1321 |
β βββ vision-overlay.js # Canvas overlay (boxes, keypoints, labels)
|
| 1322 |
β βββ vision-poses.js # Pose keypoint visualization + skeleton rendering
|
| 1323 |
β βββ vision-webgpu.js # Browser-side ONNX Runtime Web inference
|
|
|
|
| 1644 |
## License
|
| 1645 |
|
| 1646 |
Community project for Reachy Mini developers.
|
|
|
|
| 1647 |
</script>
|
| 1648 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1649 |
</body>
|
| 1650 |
+
</html>
|