docs: embedded-first getting started — same business logic everywhere (#158)#163
Merged
enricopiovesan merged 1 commit intoJul 18, 2026
Merged
Conversation
Lead root README onboarding with the production WASM-embed path for Web/Linux/CLI, demote the HTTP sidecar to an interim subsection, and cross-link the new guide from plan docs and the youaskm3 starter kit. Co-authored-by: Enrico Piovesan <enricopiovesan@users.noreply.github.com>
enricopiovesan
enabled auto-merge (squash)
July 18, 2026 08:03
enricopiovesan
deleted the
cursor/issue-158-embedded-getting-started-5d03
branch
July 18, 2026 08:04
Closed
6 tasks
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.
Summary
Add
docs/getting-started-embedded.md— a guided embedded-first path that teaches the WASM-once / UI-shell model on platforms that already embed (Web React, Linux GTK, Rust CLI). RootREADME.mdGetting Started now leads with that path and demotestraverse-cli serveto a clearly labeled Dev sidecar (Phase 1/2 interim) subsection for Apple / Android / Windows.Cross-links from
docs/embedded-runtime-plan.md,docs/traverse-starter-plan.md,docs/youaskm3-starter-kit.md, andapps/youaskm3-starter-kit/README.md.Governing Spec
docs/embedded-runtime-plan.mdtraverse-embedder-web/traverse-embedder)Project Item
Definition of Done
docs/getting-started-embedded.mdcovers mental model, clone/install, embedded Web, Linux/CLI, business-vs-UI edit guide, add-platform checklist, and platform matrix with Embed WASM runtime: Swift clients (iOS + macOS, traverse-starter + doc-approval) #114–Embed WASM runtime: Windows WinUI clients (traverse-starter + doc-approval) #116 linksValidation
Checklist
AGENTS.mdplatform table if this changes platform status (N/A — onboarding docs only)