Repository navigation
docs: explain rendering pipeline and correct VM ownership - #69
Merged
Merged
Conversation
This was referenced Oct 2, 2026
Merged
ymote
commented
Oct 2, 2026
ymote
left a comment
Collaborator
Author
There was a problem hiding this comment.
Review: needs changes before merge
Accuracy: B+. Writing: C+.
Checked against main 8f103d0 (the PR base). The pins match the org: makepad e29a0eaa and Octoscript 5991dfae, the same as OctoSense main. Removing the old "one upstream PR / isolate: false" story is the right call. The main-VM mount (main.rs:616-623, beauty.rs:140-166), crate dependencies, binaries, BEAUTY_REQUEST fields and the L0 path all check out.
Accuracy
ai::expand_ai_marksis missing. Since #68,to_makepad_uiandto_makepad_l0_uirunai::expand_ai_marks(lib.rs:62,lib.rs:86) before emitting widgets. The walkthrough says translation only emits widget source. Step 2 should also nameai.rs,state.rsandunits.rs, not justnode.rs.current_sourceis in the wrong place (walkthrough:97-99). It's in a kit-host paragraph, butcurrent_sourceexists only inapps/flutter-samples/src/lib.rs:214. kit-host hascurrent_route(file, thenSPLASH_ROUTE, then "button").- Stale comment.
apps/kit-host/src/main.rs:76-81still says the kit needs the upstream PR and mounts on an isolate. The new docs tell readers not to repeat that; update the comment in this PR. - Budgets. Only
beauty-hostuseseval_checked;kit-hostuseseval_with_append_sourcewith no budget (main.rs:617). TheAGENTS.mdline that budget-exhausted input "must fail as a whole" reads as if both hosts enforce it. - Missing crates.
makepad-d3,makepad-plotand the externaloctoscript-ui-l0crate aren't mentioned.realize_with_state,InstanceStoreandkit_packcome fromoctoscript-ui-l0, and readers will look for them here. - Smaller issues:
walkthrough:130:octoscript-node::state→octoscript_node::state.walkthrough:3-6hard-codes8f103d0c…; point atruntime.jsoninstead.walkthrough:135links to OctoSensedocs/architecture-walkthrough.md, which only exists in OctoSense #275.
Writing
There are no buzzwords. About a third of the text is disclaimers and review leftovers, though, and cutting them would shorten the doc by roughly 30%.
| Where | Current | Suggested |
|---|---|---|
README.md:12 |
junior Rust code walkthrough | code walkthrough (zh: 面向初级 Rust 开发者的源码导读 → 源码导读) |
walkthrough:3 |
This guide is for a Rust developer new to OctoSense. | Delete. |
walkthrough:84, :120 |
Commands below are source-derived recipes, not a record of a GUI/device run. / This documentation pass did not run a GPU preview. | Delete both. |
walkthrough:11-13 |
A rendered card does not acquire an AI agent, network access, or an app database just because it renders here. | Agents, network and storage come from the host; the renderer only draws. |
walkthrough:41 |
It is the portable data boundary; it is not a window or a running agent. | It is the portable data boundary between backends. |
| README Status | not a new device verification of this checkout | Device results above predate the current pins; re-run native acceptance before shipping. |
AGENTS.md:17-18 |
Do not repeat historical claims that they must wait for an isolate: false field… |
Delete; line 16 already describes the mount correctly. |
AGENTS.md:25-26 |
Record unavailable GPU/device checks honestly. Do not label structural tests as visual acceptance. | If you could not run the native check, say so in the PR. |
Also:
- Pick one spelling, Octoscript or OctoScript (README
:7vs:9). - In zh-CN the run recipe sits under 状态与验证范围, while the English has it under native validation.
AGENTS.mdasks for the two to stay aligned.
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.
Add a source-linked walkthrough of UI nodes, checked evaluation, L0 realization/lowering, AI text marks, widget translation and the native hosts. Correct README/contributor guidance about main-VM mounting and align English/Chinese run guidance.
The guide names the external L0 and chart crates and distinguishes renderer budgets, beauty-host's final checked evaluation and kit-host's final unbudgeted evaluation. Both kit-host and Flutter have
current_sourcefunctions; their distinct lookup paths are described. Also correct kit-host's obsolete source comment about an upstream prerequisite and isolate mounting. No executable behavior changes.Writing revision for junior Rust readers: Follow a small text label from source through UiNode and generated Label to native mounting. Define realization, lowering and kit bindings; move limits and preview replacement details after the normal path.
Validation: runtime manifest pins, binary declarations, relative file links across framework/octos, the published companion guide and whitespace checked. Confirmed the Rust diff is comment-only. Independent source review verified call order, budgets and VM ownership. No native GPU/device/build result is claimed.
Writing assessment after parallel revision and a separate review: 4.6/5 (A−), considering beginner orientation, terminology, worked examples, organization and consistency. This supersedes the earlier combined technical/writing score where present; it is our assessment, not an external approval.
Companion PRs: