Skip to content

Docs: align platform client READMEs with embedded vs sidecar reality #159

Description

@cursor

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

  • Every shipped client README under apps/traverse-starter/*/README.md and apps/doc-approval/*/README.md states one of:
    • Runtime mode: embedded — start/build commands with no traverse-cli serve, plus which public embedder package / bundle path is used
    • Runtime mode: HTTP sidecar (interim) — sidecar pin + URL discovery, plus link to the Phase 3 embed ticket for that platform
  • apps/traverse-starter/web-react/README.md documents the embedded path as primary (sidecar only as optional/dev fallback if still supported)
  • apps/traverse-starter/linux-gtk/README.md and apps/traverse-starter/cli-rust/README.md document embedded as primary
  • Equivalent updates for apps/doc-approval/web-react, linux-gtk, and cli-rust
  • iOS / macOS / Android / Windows READMEs for both apps explicitly say sidecar-interim and link Embed WASM runtime: Swift clients (iOS + macOS, traverse-starter + doc-approval) #114 / Embed WASM runtime: Android Compose clients (traverse-starter + doc-approval) #115 / Embed WASM runtime: Windows WinUI clients (traverse-starter + doc-approval) #116
  • Status phrases match the root README.md Platform clients table (no “Shipped (embedded)” client whose README is HTTP-only)
  • No code behavior change required; docs-only unless a README-referenced script path is broken (then fix the path or the script reference)

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions