Skip to content

docs(readme): document released microvm packages - #5

Merged
kiro-systemf[bot] merged 4 commits into
mainfrom
sys-1167-readme-setup
Nov 7, 2026
Merged

kiro-systemf[bot] merged 4 commits into
mainfrom
sys-1167-readme-setup

Conversation

@systemfsoftware-maker

Copy link
Copy Markdown
Contributor

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

  • npm metadata was reported as microsandbox 5.0.0 and daemon microVM 1.0.0; the main manifests name 5.1.2 and 1.0.3 respectively. Neither main version was reported as available on npm at the time of the check.
  • The prior clean-consumer run reported a successful install of both published packages with Effect, platform-node, and platform-node-shared pinned to 4.0.5. Its Bun example constructed a specification and reported the MicroVM.exec and 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.
  • The prior default dependency resolution selected Effect 4.1.2 and reported an import failure because effect/Crypto was absent. The installed 5.0.0 declarations were reported to export MicroVM.exec, although that release's packed README shows vm.exec. The leaf README was not changed; changing packed output requires a package patch-version bump.

README process and score

write-readme-md was 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:

Criterion Result Count
sections_5 pass 6
sections_3 pass 6
contributing fail 0
prose_density fail 4.76
relative_links pass 7
relative_links_3 pass 7
emoji_3 fail 0
emoji_10 fail 0
emoji_20 fail 0
details_3 fail 0
tables_10 fail 5
blockquote fail 0
blockquote_3 fail 0

Verification and remaining work

  • The prior run reported ./bin/dprint check README.md exited 0. No checks were rerun during publication. The simplification preflight found documentation only and made no changes.
  • Real KVM guest execution and cleanup have not been demonstrated. Final-head checks, independent review, and main CI and smoke at the actual merge SHA remain outstanding.
  • The repository's pnpm check:local requirement is pending off-host under OP28. The full pnpm check:ci is also not claimed by affected-only PR CI. No local full gate, journey, integration, or mutation suite was run in this publication stage.
  • Setup, license, constitution subtree, and complete unapplied locked-instruction proposals remain outstanding for the broader issue. This draft does not complete the issue and must not be queued or merged on the evidence above.

@systemfsoftware-maker
systemfsoftware-maker marked this pull request as ready for review November 7, 2026 18:42
@kiro-systemf
kiro-systemf Bot merged commit d023ce4 into main Nov 7, 2026
12 checks passed
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.

1 participant