Skip to content

docs: embedded-first getting started — same business logic everywhere (#158)#163

Merged
enricopiovesan merged 1 commit into
mainfrom
cursor/issue-158-embedded-getting-started-5d03
Jul 18, 2026
Merged

docs: embedded-first getting started — same business logic everywhere (#158)#163
enricopiovesan merged 1 commit into
mainfrom
cursor/issue-158-embedded-getting-started-5d03

Conversation

@enricopiovesan

Copy link
Copy Markdown
Contributor

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). Root README.md Getting Started now leads with that path and demotes traverse-cli serve to 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, and apps/youaskm3-starter-kit/README.md.

Governing Spec

  • UI-only constitution: docs do not add business-field computation or private Traverse imports
  • Phase 3 architecture: docs/embedded-runtime-plan.md
  • Public embedder surfaces only (traverse-embedder-web / traverse-embedder)

Project Item

Definition of Done

Validation

test -f docs/getting-started-embedded.md
bash scripts/ci/repository_checks.sh   # PASS

Checklist

  • Issue linked and Project 2 item updated
  • Updated AGENTS.md platform table if this changes platform status (N/A — onboarding docs only)
  • No business logic added to UI layer
  • CI gates pass locally where applicable
Open in Web Open in Cursor 

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
enricopiovesan enabled auto-merge (squash) July 18, 2026 08:03
@enricopiovesan
enricopiovesan merged commit a1af703 into main Jul 18, 2026
6 checks passed
@enricopiovesan
enricopiovesan deleted the cursor/issue-158-embedded-getting-started-5d03 branch July 18, 2026 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants