docs: add tested CLI, embedding, and WASI walkthroughs - #12
Merged
Merged
Conversation
Jairus (JairusSW)
marked this pull request as ready for review
October 2, 2026 01:41
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.
Second clean-reader pass
Repeated the public instructions from empty home, Go caches, and project directories. Current public
mainresolved to449fe89b56f591de82f36b1094c9789a83239412; beta resolved tov0.1.0-beta.11. No local Wago replacement or previously prepared project was used as fresh-install proof.Additional fixes found by this pass:
Fresh installer, beta/core/standalone, WASI/configuration, typed components, CLI, runtime/profile switching, plugin maintenance (including Wide), profiling, and authoring paths passed. Embedding's eight complete WAT programs passed against both public main and beta.11; AssemblyScript and TinyGo alternatives passed. The fresh public-module regression passed eight programs and seven race-enabled API tests. Authoring's race-enabled snippet regression passed and rejected all three reverted-bug mutations.
Final local
npm ciandnpm run docs:check: 18 tests, production build, 25 deployment artifacts, 81 pages, and 4,357 internal links/anchors passed. Final tutorial external-link sweep: 35/35 HTTP 200. Independent final review found no blockers. Docs CI passed for exact headb327afa9722076b421931541842206e3b81a4172.See clean-reader verification and limits for reproducible setup and coverage. Linux watch still requires unavailable procfs child lists; native perf is absent; local browser navigation was blocked. TinyGo used the documented compatible Go pair plus a disclosed sandbox-only VCS-stamping adjustment. No other platform execution is claimed. Recording commands and displayed results are unchanged, so the three previously verified generated GIFs are retained.
Default-version limitation: the site root still opens the frozen beta snapshot. Its old prerequisite/authoring guidance remains unchanged; its first embedding example does currently pass. This PR updates canary source and shared navigation.
beta/,.docs-snapshots/, andversions.jsonremain untouched. The normal release workflow must create a qualified snapshot before the corrected guide text becomes the default release docs.What changed
Walked through the docs with the actual runtime and kept the guides organized around things a reader can do.
These edits target the root canary documentation. The release-owned
beta/tree, immutable snapshots, andversions.jsonare unchanged. The regular beta snapshot workflow can pick up the new guides when the matching code is qualified.What ran
Primary runtime baseline: wago b084a7c9, Linux/amd64, Go 1.27.1. Public plugin fixtures pin their actual dependencies; CLI installs tested WASI 0.3.1 and Component Model 0.1.6.
npm run docs:checkpassed: unit tests, production build, 25 artifact checks and 81 indexed pagessrc/wagosuite passed after fetching the pinned Core 3 corpus; 130 test packages passed in the 176-package selection excluding the two watch-dependent packagesSee the fixture READMEs under demos/fixtures for rerun commands. The embedding checker reads the actual Markdown programs rather than a duplicate copy.
Limits and findings
go test ./...hit Linux watch/supervisor tests that require procfs child lists and process controls absent in this sandbox; those two packages are explicitly excluded from the passing selection abovetinygo_task_exit; a minimal program without Wago reproduces it. The guide gives the verified 0.41.1 pathplugin configcan persist a value that later fails provider startup; config schemas do not enforce every value constraint. The docs now require an actual startup smoke test and provider-side validationos.ReadFilerequested rights beyond a read-only mount; the docs explain the diagnosis without recommending broader rights by defaultGIFs
The existing VHS/humanized-tape path remains the default. Chromium could not start in this execution environment because local sockets are restricted, so the committed recordings use the documented browser-free
aggpath. It reads the same tapes, executes the visible commands, records actual combined output, and fails if a command fails. No downloads or terminal results are mocked. All three GIFs were rendered and their frames inspected; historical release recordings are unchanged.The first pass included source/accuracy, link, and diff review. The additional clean-reader findings and fixes are recorded above.