docs: align platform READMEs with embedded vs sidecar reality (#159)#162
Merged
Merged
Conversation
Add a Runtime mode line to every traverse-starter and doc-approval client README, rewrite web-react starter for embedded WASM, and stop describing sidecar-interim natives as the same path as embedded web. Co-authored-by: Enrico Piovesan <enricopiovesan@users.noreply.github.com>
enricopiovesan
marked this pull request as ready for review
July 18, 2026 08:02
enricopiovesan
enabled auto-merge (squash)
July 18, 2026 08:02
7 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
2 participants
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
Align every
traverse-starteranddoc-approvalplatform client README with the root Platform clients table: Web / Linux / CLI document Runtime mode: embedded (no required sidecar); iOS / macOS / Android / Windows document Runtime mode: HTTP sidecar (interim) with links to #114 / #115 / #116.Rewrites
apps/traverse-starter/web-react/README.mdfor the shipped embedded host (traverse-embedder-web+ bundle sync) and removes incorrect “same flow as web-react” wording from Android/Windows sidecar clients.Governing Spec
docs/embedded-runtime-plan.md)Project Item
Definition of Done
apps/traverse-starter/*/README.mdandapps/doc-approval/*/README.mdstates Runtime mode (embedded or HTTP sidecar interim)web-react/linux-gtk/cli-rustfor both apps document embedded as primaryAGENTS.md/ root README matrix) unchanged — mode labels match existing tableValidation
Checklist
AGENTS.mdplatform table if this changes platform status (N/A — docs alignment only)