docs: tighten README quick start and stale comments
ci / check (push) Successful in 1m20s
ci / check (pull_request) Successful in 51s

- Lead with purpose and exact local/CI commands.
- Remove local absolute paths, stale auth notes and unverified claims.
- Keep comments to the reason or invariant they protect.
This commit is contained in:
Noel Sabia committed 2026-11-14 09:16:19 +01:00
1 parent dbb7a009a7
commit 66b80a62fb
14 files changed
+82 -84

No files matched your search

+1 -1
View File
@@ -121,7 +121,7 @@ const usingMock = computed(() => ['1', 'true'].includes(String(config.public.use
</div>
<ul class="small" style="margin: 0; padding-left: 1.1rem; display: grid; gap: var(--onyx-density-xs)">
<li>No PII, MAC addresses or geolocation permission.</li>
<li>Audience sessions use a random ID only.</li>
<li>No analytics, tracking cookies or local storage on public screens.</li>
<li>Public read-only screens; control actions are authenticated separately.</li>
<li>Raw challenge CSV and secrets stay out of this repository.</li>
</ul>
+1 -1
View File
@@ -98,7 +98,7 @@ async function apply(preset: ScenarioPreset) {
<div>
<OnyxHeadline is="h2">Scenario presets</OnyxHeadline>
<p class="small muted" style="margin: 0">
The enum is fixed by CONTRACT.md. Weather and event values match the demo narrative.
The enum is fixed by the API contract. Weather and event values match the demo narrative.
</p>
</div>
<OnyxBadge color="info" density="compact">server proxy</OnyxBadge>
+4 -3
View File
@@ -139,8 +139,9 @@ const latestPulse = computed(() => {
</div>
<p class="small muted table-note">
The CSV is static. The replay clock is {{ formatDateTime(demoNow) }}; the last measured point is
{{ lastPoint ? formatDateTime(lastPoint.t) : '—' }}. No live sensor feed is claimed.
This is a replay snapshot, not a live sensor feed. The replay clock is
{{ formatDateTime(demoNow) }}; the last measured point is
{{ lastPoint ? formatDateTime(lastPoint.t) : '—' }}.
</p>
</OnyxCard>
@@ -149,7 +150,7 @@ const latestPulse = computed(() => {
<div>
<OnyxHeadline is="h2">Sensor cluster</OnyxHeadline>
<p class="small muted" style="margin: 0">
Select a sensor to update the reading. Bounds are relative; the basemap is the next map slice.
Select a sensor to update the reading. Positions are relative; this is not a geographic map.
</p>
</div>
<OnyxBadge color="info" density="compact">580 m cluster</OnyxBadge>
+1
View File
@@ -36,6 +36,7 @@ const {
})),
})
// Same scenario id with a new version: refresh because the query string does not move.
let lastScenarioId = live.scenarioId
watch(
() => live.revision,
+1 -2
View File
@@ -109,8 +109,7 @@ const EMPTY_PLAN: StaffingResponse = {
context_version: '',
}
// The hero plan comes from the Go API. Local assumption edits only render a
// preview from the API's own forecast hours; they never replace the API plan.
// The Go plan is the source; assumption edits render a local preview only.
const {
data: apiPlanData,
status,