2 Commits
Author SHA1 Message Date
james.maesandClaude Opus 4.7 0cc94c637a docs(branding): assets/branding/ + restore MIT license section
- Add assets/branding/README.md with shot list for the five high-impact
  brand assets (social preview, logo, hero shot, app icon, banner) and
  GitHub upload instructions for each.
- Add assets/branding/STYLE.md documenting the colour palette (cyan
  family + HUD navy/black + warning/critical), typography (Eurostile /
  Saira / Orbitron family for display, SF Pro for UI), and tone of
  voice ("terse, technical, dryly opinionated, slightly sardonic").
- Drop five .todo placeholder files so the directory tree shows intent
  without faking assets.
- Restore the README License section to a clean MIT pointer (a
  concurrent agent had reverted it to "decision still open"; that
  decision is now made and lives at .planning/decisions/license.md).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-12 15:09:14 -05:00
james.maesandClaude Opus 4.7 c4c32f7aae docs(readme): refresh — diagrams + architecture + culture + roadmap
Audit-and-rewrite of root README against current truth (2026-05-12).
The previous README was accurate but list-shaped and unillustrated;
the rewrite reorients around what a new reader (human or AI agent)
needs in 60 seconds.

New / changed sections:
- Tagline + two-paragraph intro (what / who / why)
- Status banner pointing at GitHub Issues + Milestones (canonical)
- Screenshots placeholder + shot list under assets/screenshots/
- "Architecture at a glance" with a top-level mermaid flowchart
  (Swift host + LLM providers + WKWebView, with 14 nodes)
- Subsystems table — eight first-class + supporting packages
- "Install order" section with a mermaid DAG of the AppDelegate
  install sequence (vision → agent → voice, plus parallel
  memory/MCP/replay), matching check-install-order.sh
- "Agent turn lifecycle" mermaid showing the orchestrator → single
  broadcaster fanout, with the strict-mode degradation preamble
  inject point called out
- "Boot-health probes" mermaid for the eight NOT FAKED probes →
  rollup → menu-bar icon / banner / agent preamble
- "Project culture" section codifying the in-code-docs philosophy,
  NOT FAKED probes, strict-mode escalation, 18 boundary gates, the
  three-name test-double taxonomy, audit-and-stabilize cadence,
  and the GitHub-Issues-is-canonical policy
- "Roadmap" reorganized around the v0.1 → v1.1 milestones from
  GitHub Milestones (user-outcome-focused, not subsystem-focused)
- Build & run cleaned up; boundary-gates one-liner; opt-in
  real-hardware test commands kept

Also adds assets/screenshots/README.md with a prioritized shot
list — eight screenshots in priority order — and a note on why
diagrams stay as inline mermaid (GitHub-native, no re-export).

Removed: the older "Status" subsystem-state table, which had
become a mix of v0.12.0 milestone audit terms (Track A/B/C/D,
B-8) that don't map cleanly to the new GitHub Issues taxonomy.
Status now points at GitHub Issues + Milestones as the source
of truth.

Gates: 17/18 pass. check-app-builds.sh fails on the in-flight
AppDelegate.swift rewrite (unstaged, owned by a parallel agent)
— unrelated to this markdown-only change. Confirmed only
README.md + assets/screenshots/README.md are staged here.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-12 15:00:21 -05:00