Scale back scope: simplify ROADMAP + slim/correct docs#155
Merged
Conversation
Scale back the public-facing scope and cut docs for things that are aspirational, redundant, or contradicted by the 'won't build' list. ROADMAP (simplified to two sections, no over-promising): - collapsed to 'What works today' + 'Maybe someday' + a won't-build line - dropped stale/done items (whisper ASR swap and privacy LEDs both shipped; kid-ASR accuracy mitigations landed) after verifying against the code - added 'Improve Security Mode' Deleted (verified aspirational/redundant/spent): - docs/signed-releases.md — GPG signing was commented-out scaffold only - docs/advanced/variant-port-guide.md — firmware is CoreS3-only - docs/hardware-support.md — redundant with hardware.md (the 'matrix' is a won't-build item) - docs/speaker-id-investigation.md — superseded by latent-capabilities.md - docs/vision-alignment-review-2026-05-29.md — spent audit; findings fixed by #129 - KEYS.txt + the firmware-release GPG-signing scaffold — descoped with signed-releases Trimmed to match reality: - observability.md — only kid_mode + content_filter_hits actually record today; the other 8 metrics are schema-only. Marked live-vs-unwired; cut phantom alerts. - ota-verification.md — noted firmware-update OTA isn't set up (WS discovery + clock only) - reproducible-builds.md — dropped dead signed-releases reference Corrected: - modes.md — LED contract described active-fork StateManager (6=face,11=listening); the pinned submodule (35f701a) ships privacy LEDs (6=mic green, 11=camera red) and has no StateManager. Added a precise two-firmware caveat. - README — ASR bullet now notes WhisperLocal/SenseVoiceOnnx; added Privacy LEDs feature Link hygiene: remapped 6 hardware-support links to hardware.md, removed deleted docs from mkdocs nav, dropped the signed-releases cross-ref from sbom.md. No dangling markdown links remain in lychee-scanned files. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…LED layout with shipped privacy LEDs Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Scales back and re-aligns the project’s public docs to match what’s actually shipped, by simplifying the roadmap, removing spent/aspirational documentation, and correcting/clarifying a few hardware/firmware and observability/OTA claims.
Changes:
- Simplifies
ROADMAP.mdinto “What works today” + “Maybe someday”, removing extensive v0.1-era inventories. - Deletes multiple docs that are now redundant/spent (signed releases scaffold, variant port guide, hardware support matrix, audit/investigation notes) and updates nav/link targets accordingly.
- Updates key docs to reflect current reality (README feature bullets, OTA not wired, observability metrics status, LED contract caveat for two firmware layouts).
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
ROADMAP.md |
Collapses roadmap scope and summarizes “works today” vs “maybe someday”. |
README.md |
Updates rough edges + ASR options, adds privacy LED feature note, clarifies LED layout differences. |
mkdocs.yml |
Removes nav entries for deleted docs and flattens Hardware nav entry. |
KEYS.txt |
Removes unused signed-releases key placeholder file. |
docs/vision-alignment-review-2026-05-29.md |
Deletes spent audit snapshot doc. |
docs/speaker-id-investigation.md |
Deletes superseded investigation log doc. |
docs/signed-releases.md |
Removes signed releases documentation scaffold. |
docs/sbom.md |
Drops cross-reference to signed releases doc. |
docs/reproducible-builds.md |
Updates to reflect checksums-only verification (no GPG signing). |
docs/quickstart.md |
Fixes hardware link target after hardware-support doc deletion. |
docs/ota-verification.md |
Clarifies OTA firmware-update flow isn’t wired in this project. |
docs/observability.md |
Marks metrics as minimal; distinguishes recorded vs schema-only metrics. |
docs/modes.md |
Adds explicit caveat about two firmware right-ring LED layouts. |
docs/hardware-support.md |
Deletes redundant hardware support matrix doc. |
docs/faq.md |
Updates hardware doc links to point at hardware.md. |
docs/about.md |
Updates hardware doc link to point at hardware.md. |
docs/advanced/variant-port-guide.md |
Deletes variant board port guide (descoped). |
.github/workflows/firmware-release.yml |
Removes commented-out GPG signing scaffold from workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Brain via the `dotty-pi` container (pi coding agent with voice tools) | ||
| - Perception events (face detection, sound events) through `dotty-behaviour` | ||
| - Admin dashboard via `bridge.py` | ||
| - Kid Mode, on by default — prompt-level steering for age-appropriate responses, **not** an output content filter, and no substitute for supervision |
Comment on lines
+82
to
+85
| The contract below describes the **active-fork Phase 4 StateManager** | ||
| (`BrettKinny/StackChan @ dotty`). The firmware **submodule pinned in this | ||
| repo** (`35f701a`) does **not** include StateManager — it ships the | ||
| **privacy-LED** layout instead, which claims two of the same right-ring |
Comment on lines
39
to
45
| nav: | ||
| - Home: README.md | ||
| - Getting Started: SETUP.md | ||
| - Quickstart: quickstart.md | ||
| - Architecture: architecture.md | ||
| - Hardware: | ||
| - Hardware: hardware.md | ||
| - Hardware Support: hardware-support.md | ||
| - Hardware: hardware.md | ||
| - Voice Pipeline: voice-pipeline.md |
…consolidating Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Deliberately scaling back the project's public-facing ambition — keeping it fun, not a time sink. A swarm of agents verified each claim against the actual code/CI/firmware before anything was cut, so deletions are for things that are genuinely aspirational, redundant, or already done.
ROADMAP
Collapsed to two honest sections (What works today + Maybe someday) plus a short "won't build myself" line. Verified against code, then:
Docs deleted (verified aspirational / redundant / spent)
signed-releases.md+KEYS.txt+ workflow GPG scaffoldadvanced/variant-port-guide.mdhardware-support.mdhardware.md; the "matrix" is a won't-build itemspeaker-id-investigation.mdlatent-capabilities.mdvision-alignment-review-2026-05-29.mdDocs trimmed to match reality
kid_mode+content_filter_hitsactually record; the other 8 metrics are schema-only. Marked live-vs-unwired, cut phantom alerts.signed-releasesreference.Corrected
35f701a) ships privacy LEDs (6=mic green, 11=camera red) and has no StateManager. Added a precise two-firmware caveat.Link hygiene
Remapped 6
hardware-supportlinks tohardware.md, removed deleted docs frommkdocs.ymlnav, dropped thesigned-releasescross-ref fromsbom.md. No dangling markdown links remain in lychee-scanned files; both workflows and the mkdocs nav parse clean.Net: 18 files, +74 / −1000 (plus the README finalize commit).
🤖 Generated with Claude Code