Skip to content

docs: drop the debt and debugging entries #576, #579 and #583 fixed - #607

Merged
bonk-ai[bot] merged 1 commit into
mainfrom
docs/nightly-2026-10-13
Oct 13, 2026
Merged

bonk-ai[bot] merged 1 commit into
mainfrom
docs/nightly-2026-10-13

Conversation

@bonk-ai

@bonk-ai bonk-ai Bot commented Oct 13, 2026

Copy link
Copy Markdown
Contributor

What and why

Three docs boxes of tracker #605: docs/insights/tech-debt.md items 5 and 10 and their "Shows up in" bullets, the Serve entry in docs/insights/debugging-guide.md, and the .vale/warnings.json ceilings. The branch starts from main at e209162.

Debt the code no longer has

  • tech-debt item 5 said declaration generation resolves @napi-rs/cli@3 afresh. Pin release build tools and validate tag inputs #576 pinned it: .config/mise/tasks/contracts.toml:275 and :305 run @napi-rs/cli@3.8.2, and bindings/microvms-js/package.json:53 pins 3.8.2. The row is removed, and so are the two napi bullets and the napi half of "Generator versions have multiple owners".
  • tech-debt item 10 said lifecycle commentary claims Sandbox can't address a VM launched elsewhere. docs: align source notes and CLI installation with current APIs #579 rewrote that module doc: crates/microvms-cli/src/commands/lifecycle.rs:10-13 describes Sandbox::adopt. The row is removed, and "Explanations and repeated constants need an owner" becomes "The daemon port default needs an owner", keeping its three port-default bullets.
  • The debugging-guide entry said a listener without L::Addr: Debug can make Serve appear not to implement Future. Bound daemon hooks, connections, and archive replacement #583 replaced axum::serve with a hyper accept loop (crates/agentd/src/serve.rs:23-72), so there is no Serve future to misreport. The bound is still at serve.rs:26, and nothing in the function body uses the address, so we removed the entry instead of rewording it around the bound.

Items 6 to 9 move up to 5 to 8. No page under docs/ cites a tech-debt item by number, and among #567 to #573 and #605 only #605's box for items 5 and 10 does.

Item 8, narrowed

Item 8 (now 7) said the Maturin version is repeated with no agreement check. #576 added test_python_build_commands_use_the_stub_generator_pin (tools/test_check_release_builds.py:91-105), which reads MATURIN from tools/generate-py-stubs.py:89 and requires .config/mise/tasks/test.toml, .github/workflows/release.yml and bindings/microvms-py/AGENTS.md to name the same version. The proof runner's PY_BUILD (tools/fail-to-pass.py:101-108) isn't in that test's list. tools/test_fail_to_pass.py:408-420 holds the guard registry's bindings entries to PY_BUILD, which ties the registry to the proof runner and leaves the proof runner unchecked against the generator. The row and its section now say that.

Citations #600 and #601 moved

On the two pages, 15 citations of exit.rs, error.rs, config.rs, exec.rs, protocol/src/exec.rs and bindings/microvms-py/src/errors.rs moved by #600 (e209162) and #601 (a4047ea). Each move is byte-equal: the cited block at the doc line's git blame commit occurs once at HEAD, at the new range. The tech-debt port-default citation crates/agentd/src/config.rs:101-104 is now :118-121 (impl Default for Config, port: 9000).

See-also footers

The 19 pages under docs/ with a see-also footer ended with "N shared source citations" on each see-also link. AGENTS.md's "Counts in docs" rule allows a number only when the build generates it or it's a dated measurement; no tool in the tree writes these, and this change would have made several stale. Each footer now opens with one sentence saying why the pages are listed, and the counts are gone; the order is unchanged.

Vale ceilings

.vale/warnings.json drops 25 ceilings to the counts on this branch, which include the drops #598, #600 and #601 left on main. No rule's count rose against main.

Unverified: whether the L::Addr: Debug bound at serve.rs:26 can be removed; that is a source question for the bound's owner.

Evidence

  • mise run docs:check on this branch: EXIT=0 in 240 s; astro check 0 errors and 0 warnings, and vitest 15 files, 223 tests passed.
  • mise run prose:check on this branch: EXIT=0 in 45 s, "Prose: 0 errors, 4069 warnings, 0 suggestions." Main at e209162 has 4083 warnings against the same rules.
  • Seeded-fault anchors: no transform in verify/guards/faults/*.toml names an edited file.
  • Every moved citation's first line at HEAD matches its block's first line at the blame commit (dump: 15 of 15).
  • mise run pr-body:check -- --body <this body>: EXIT=0.
  • mise run check: not run; this changes only Markdown under docs/ and .vale/warnings.json, and prose:check is the check tier that reads both.

Guards

None: this adds no guard.

Follow-ups

Platform claims

  • Not applicable: this changes no claim about AWS behavior.

Scope

  • This is not an orchestrator or a fork implementation
    (see docs/STRATEGY.md).

tech-debt.md loses items 5 (napi generator pin, fixed by #576) and 10
(lifecycle commentary, fixed by #579) and the bullets that cited them;
item 8 now names #576's agreement test and the proof-runner copy it
leaves out. debugging-guide.md drops the Serve-not-Future entry that
#583's accept loop retired. 15 citations #600 and #601 moved on those
pages are re-pointed by exact text match. The see-also footers on 19
pages drop their hand-written citation counts (AGENTS.md, Counts in
docs), and .vale/warnings.json lowers 25 ceilings to this tree's counts.

docs:check EXIT=0 (240 s), prose:check EXIT=0 (0 errors, 4069 warnings).
@bonk-ai
bonk-ai Bot merged commit 683cd37 into main Oct 13, 2026
33 checks passed
@bonk-ai
bonk-ai Bot deleted the docs/nightly-2026-10-13 branch October 13, 2026 08:41
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.

0 participants