Summary
Audit and update per-platform client READMEs so each clearly states whether that client runs embedded WASM (no traverse-cli serve) or HTTP sidecar interim, how to start it, and which public Traverse surface it uses.
This removes the current contradiction where the root README marks Web/Linux/CLI as “Shipped (embedded)” while some client READMEs still describe HTTP-only Phase 1 setup as the only path.
Why
Agents and humans copy the nearest README. Stale sidecar-only instructions on already-embedded clients teach the wrong production model and block a trustworthy e2e learning path.
Depends on
Blocked by
Architecture boundary
- README instructions may only reference public HTTP API (spec 033) for sidecar-interim clients, or public embedder SDK packages for embedded clients.
- No private Traverse imports, no fake execute/poll stubs, no UI-computed business fields in examples.
Definition of Done
Validation
# Spot-check mode lines exist
rg -n "Runtime mode:" apps/traverse-starter/*/README.md apps/doc-approval/*/README.md
# Embedded clients must not require serve as the only path
rg -n "traverse-cli serve" apps/traverse-starter/web-react/README.md \
apps/traverse-starter/linux-gtk/README.md \
apps/traverse-starter/cli-rust/README.md \
apps/doc-approval/web-react/README.md \
apps/doc-approval/linux-gtk/README.md \
apps/doc-approval/cli-rust/README.md
# Acceptable only as optional/dev fallback text, not as the sole Getting Started path
bash scripts/ci/repository_checks.sh
bash scripts/ci/onboarding_check.sh
Manual: open each updated README and confirm a newcomer can pick the correct start command for that platform’s actual runtime mode.
Summary
Audit and update per-platform client READMEs so each clearly states whether that client runs embedded WASM (no
traverse-cli serve) or HTTP sidecar interim, how to start it, and which public Traverse surface it uses.This removes the current contradiction where the root README marks Web/Linux/CLI as “Shipped (embedded)” while some client READMEs still describe HTTP-only Phase 1 setup as the only path.
Why
Agents and humans copy the nearest README. Stale sidecar-only instructions on already-embedded clients teach the wrong production model and block a trustworthy e2e learning path.
Depends on
README.md(source of truth for status labels)Blocked by
Architecture boundary
Definition of Done
apps/traverse-starter/*/README.mdandapps/doc-approval/*/README.mdstates one of:traverse-cli serve, plus which public embedder package / bundle path is usedapps/traverse-starter/web-react/README.mddocuments the embedded path as primary (sidecar only as optional/dev fallback if still supported)apps/traverse-starter/linux-gtk/README.mdandapps/traverse-starter/cli-rust/README.mddocument embedded as primaryapps/doc-approval/web-react,linux-gtk, andcli-rustREADME.mdPlatform clients table (no “Shipped (embedded)” client whose README is HTTP-only)Validation
Manual: open each updated README and confirm a newcomer can pick the correct start command for that platform’s actual runtime mode.