Repository navigation
docs: drop the debt and debugging entries #576, #579 and #583 fixed - #607
Merged
Merged
Conversation
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).
35 of 45 tasks
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.
What and why
Three docs boxes of tracker #605:
docs/insights/tech-debt.mditems 5 and 10 and their "Shows up in" bullets, theServeentry indocs/insights/debugging-guide.md, and the.vale/warnings.jsonceilings. The branch starts from main at e209162.Debt the code no longer has
@napi-rs/cli@3afresh. Pin release build tools and validate tag inputs #576 pinned it:.config/mise/tasks/contracts.toml:275and:305run@napi-rs/cli@3.8.2, andbindings/microvms-js/package.json:53pins3.8.2. The row is removed, and so are the two napi bullets and the napi half of "Generator versions have multiple owners".Sandboxcan'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-13describesSandbox::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.L::Addr: Debugcan makeServeappear not to implementFuture. Bound daemon hooks, connections, and archive replacement #583 replacedaxum::servewith a hyper accept loop (crates/agentd/src/serve.rs:23-72), so there is noServefuture to misreport. The bound is still atserve.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 readsMATURINfromtools/generate-py-stubs.py:89and requires.config/mise/tasks/test.toml,.github/workflows/release.ymlandbindings/microvms-py/AGENTS.mdto name the same version. The proof runner'sPY_BUILD(tools/fail-to-pass.py:101-108) isn't in that test's list.tools/test_fail_to_pass.py:408-420holds the guard registry's bindings entries toPY_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.rsandbindings/microvms-py/src/errors.rsmoved by #600 (e209162) and #601 (a4047ea). Each move is byte-equal: the cited block at the doc line'sgit blamecommit occurs once at HEAD, at the new range. The tech-debt port-default citationcrates/agentd/src/config.rs:101-104is 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.jsondrops 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: Debugbound atserve.rs:26can be removed; that is a source question for the bound's owner.Evidence
mise run docs:checkon this branch: EXIT=0 in 240 s;astro check0 errors and 0 warnings, and vitest 15 files, 223 tests passed.mise run prose:checkon this branch: EXIT=0 in 45 s, "Prose: 0 errors, 4069 warnings, 0 suggestions." Main at e209162 has 4083 warnings against the same rules.transforminverify/guards/faults/*.tomlnames an edited file.mise run pr-body:check -- --body <this body>: EXIT=0.mise run check: not run; this changes only Markdown underdocs/and.vale/warnings.json, andprose:checkis thechecktier that reads both.Guards
None: this adds no guard.
Follow-ups
crates/microvms-cli/src/cli.rs,crates/microvms-app/src/sandbox.rs,crates/microvms-app/src/session/mod.rsand other files feat(agentd): an image-set default user for execs that omituser(#595) #600 and fix(core): let the service decide a resume past the suspended window (#597) #601 changed moved on pages this change doesn't touch,docs/reference/cli.mdmost of all.lifecycle.rs:2010, the fiveal2023-1docstrings,microvm.rs:709) are outside a docs change.Platform claims
Scope
(see
docs/STRATEGY.md).