Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions apps/youaskm3-starter-kit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,20 @@ It is intentionally small:
- it points to the browser-targeted consumer package in this repo
- it points to MCP consumption and compatibility validation docs in Traverse
- it leaves downstream UI and product behavior to the consuming app
- it points hosts at Specs 001/002 presentation-state vocabulary (do not invent business fields in UI)

## What It Is For

Use this starter kit as the first place a downstream app developer looks when wiring Traverse into a browser-hosted app such as `youaskm3`.

Prefer primary product shells (`traverse-starter`, `doc-approval`, `meeting-notes`) when you want the multi-OS embedded reference pattern — not expedition sample apps.

## Included References

- [Embedded getting started (this repo)](../../docs/getting-started-embedded.md) — WASM-once / UI-shell model on Web + Linux/CLI
- [Consumer bundle (Traverse)](https://github.com/traverse-framework/Traverse/blob/main/docs/app-consumable-consumer-bundle.md)
- [Starter kit guide (this repo)](../../docs/youaskm3-starter-kit.md)
- [Event UI conformance harness](../../docs/event-ui-conformance-harness.md) — Specs 001/002 fixtures + mappers
- [Integration validation (Traverse)](https://github.com/traverse-framework/Traverse/blob/main/docs/youaskm3-integration-validation.md)
- [Compatibility suite (Traverse)](https://github.com/traverse-framework/Traverse/blob/main/docs/youaskm3-compatibility-conformance-suite.md)
- Local consumer package: [`apps/browser-consumer/`](../browser-consumer/)
Expand All @@ -29,6 +33,7 @@ Use this starter kit as the first place a downstream app developer looks when wi
- The consuming app is browser-hosted.
- The consuming app uses the published Traverse consumer bundle.
- The consuming app depends on the browser-targeted consumer package rather than Traverse internals.
- Session chrome uses Spec 001 states (`idle|loading|loaded|blocked|ended|error`) from public subscribe evidence.
- The consuming app validates paths using the documented commands in this repository and Traverse.

## Validation
Expand Down
17 changes: 13 additions & 4 deletions docs/youaskm3-starter-kit.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,18 @@ Downstream apps should adopt the versioned Traverse consumer bundle and the brow

- Traverse consumer-bundle docs: [app-consumable-consumer-bundle.md](https://github.com/traverse-framework/Traverse/blob/main/docs/app-consumable-consumer-bundle.md)
- Local façade: [`apps/browser-consumer/`](../apps/browser-consumer/)
- Event → UI contract: [`event-ui-conformance-harness.md`](event-ui-conformance-harness.md) (Specs 001/002)

## UI event contract

Hosts must:

1. Subscribe through public consumer / embedder surfaces (replay-safe ordered events).
2. Map evidence to Spec 001 presentation states: `idle | loading | loaded | blocked | ended | error`.
3. For multi-capability progress, follow Spec 002 — show invoke/result order from the stream.
4. Render only runtime-provided fields (no invented titles, tags, recommendations, or scores).

`apps/browser-consumer` exposes `presentationState` for Spec 001 chrome. Prefer primary shells when you need the full multi-OS embedded pattern.

## Setup

Expand All @@ -32,15 +44,12 @@ Offline (always available in this repo):

```bash
bash scripts/ci/youaskm3_starter_kit_smoke.sh
bash scripts/ci/react_demo_smoke.sh
bash scripts/ci/browser_consumer_package_smoke.sh # requires TRAVERSE_REPO for live path
```

Live adapter path (requires `TRAVERSE_REPO`):
Live adapter path (requires `TRAVERSE_REPO`; talks to `browser-adapter serve` via browser-consumer — no expedition demo proxy):

```bash
export TRAVERSE_REPO=/path/to/Traverse
bash scripts/ci/react_demo_live_adapter_smoke.sh
bash scripts/ci/browser_consumer_package_smoke.sh
```

Expand Down
Loading