Repository navigation
docs(readme): document released microvm packages - #5
Merged
Merged
Conversation
systemfsoftware-maker
marked this pull request as ready for review
November 7, 2026 18:42
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
Readers can identify the published microVM packages, distinguish them from unreleased main, and try a pinned consumer configuration. This is the README slice only; repository setup, the constitution subtree, and the reserved instruction-file proposals remain outside this PR.
Related to SYS-1167
Release and consumer evidence
5.0.0and daemon microVM1.0.0; the main manifests name5.1.2and1.0.3respectively. Neither main version was reported as available on npm at the time of the check.4.0.5. Its Bun example constructed a specification and reported theMicroVM.execand daemon-medium exports; it did not boot a guest. The original raw receipt is unavailable in this publication environment, so these are reported results, not independently verified receipts.4.1.2and reported an import failure becauseeffect/Cryptowas absent. The installed5.0.0declarations were reported to exportMicroVM.exec, although that release's packed README showsvm.exec. The leaf README was not changed; changing packed output requires a package patch-version bump.README process and score
write-readme-mdwas used with the monorepo and library shape references, structure, root-design, and prose-humanizer guidance. The author reported checking package metadata, installed declarations, source exports, relative links, and light/dark Bun-rendered previews. No Gemini copy rewrite was needed. The npm microsandbox page returned HTTP 403 to the reported HEAD request; that link was not verified by that check. The preview was not a GitHub-rendered capture.The actual scorer reported 4/13:
Verification and remaining work
./bin/dprint check README.mdexited 0. No checks were rerun during publication. The simplification preflight found documentation only and made no changes.pnpm check:localrequirement is pending off-host under OP28. The fullpnpm check:ciis also not claimed by affected-only PR CI. No local full gate, journey, integration, or mutation suite was run in this publication stage.