Repository navigation
docs: re-point the source citations the 2026-10-11 changes moved after #555 - #590
Merged
Merged
Conversation
…#555 #555 refreshed the path:line citations in the hand-written reference, behavior, architecture, analysis, diagram and insight pages; source changes merged after it moved code under them. Each citation now names the HEAD range that holds the text it named at its doc line's blame commit: an exact match for most, a read-only audit for the rest. public-api.md's facade citation pointed at a blank line and now cites the re-export block, and state-machines.md names the Open case caller_vanished gained in #585. Splitting that sentence at its semicolon lowers ai-tells.SemicolonUsage's ceiling by one. Sentences the code now contradicts (tech-debt.md items 5 and 10, debugging-guide.md's Serve entry) keep their old citations; see the PR body's Follow-ups. docs:check and prose:check pass.
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
#555 (298d986) refreshed the
path:linecitations in the hand-written reference, behavior, architecture, analysis, diagram and insight pages against its own tree. The commits merged after it on 2026-10-11 that touch source, tasks, tools orverify/(#556, #557, #574, #575, #576, #578, #579, #580, #581, #582, #583, #584, #585, #586, #587 and the 1.0.0 version commit #588) moved code in the cited files, so many citations still resolve, which is alldocs:checktests, while pointing a few lines away from the code they named. This re-points them to HEAD (9a14279, the v1.0.0 tag) and corrects one sentence a source change made incomplete.How each citation was moved
The baseline for each citation is the commit that last wrote its doc line (
git blame): 298d986 (#555) for most lines, a19e0f0 (#556, which reworded prose and kept the numbers) for some, and 5fc581b for a few lines #555 kept unchanged. For the 5fc581b lines, the cited text at 298d986 is the same text at the same line, so #555's tree is their baseline too.routes.rs:31-56became31-57because platform hooks gained their own routing line, andhttp.rs:109-128became116-136becausesendnow reads bodies throughcollect_body. Twelve rows the audit checked were already right and are unchanged.docs/reference/public-api.md:5citedcrates/microvms-core/src/lib.rs:98, which was a blank line at 298d986 too. It now citeslib.rs:85-95, the facade's re-export block (microvms_domainat 87,microvms_appat 90,microvms_edgesat 91,protocolat 95), which is what the sentence describes.docs/behavior/state-machines.md(GuestRead): Bind verified tunnel sessions to their requested destination #585 madecaller_vanishedleave the guest atOpenwhen the daemon never connected to the guest port (crates/model/src/tunnel.rs:507-516:if !next.daemon.dialed { GuestRead::Open } ...;dialedis documented attunnel.rs:300-301as "The daemon connected to the guest port."). The sentence said it always choosesResetorEof, so it now names theOpencase first. It is also split at its semicolon. That removes oneai-tells.SemicolonUsagewarning, and.vale/warnings.jsonlowers that rule's ceiling from 299 to 298, as CONTRIBUTING's "Prose checks" section asks.Pages touched:
docs/reference/cli, public-api, rpc-tools;docs/behavior/processes, state-machines;docs/architecture/data-flow, module-map, system-overview;docs/analysis/dead-code, ownership, risk-hotspots;docs/diagrams/components, sequences, dependency-graph;docs/insights/business-logic, contract-map, debugging-guide, impact-analysis, tech-debt. No line was added or removed, and no fenced evidence document (PROTOCOL, TRUST, PLATFORM) changed.Left unchanged on purpose
Eight audited rows describe behavior the code no longer has, so moving their citations would point a false sentence at code that refutes it. They keep their old citations and are listed under Follow-ups. Unverified: 29 citations of
Cargo.tomllines that differ from the baseline only in a version string (the 1.0.0 bump) were left in place after a mechanical check, not read one by one.Evidence
mise run docs:checkon this tree: EXIT=0 in 101 s, vitestTest Files 14 passed (14)andTests 216 passed (216). It resolves everypath:linecitation against git and fails on a dead path. main at 9a14279 passed the same task in a fresh worktree (305 s).mise run prose:checkon this tree: EXIT=0 in 22 s,Prose: 0 errors, 4111 warnings(main at 9a14279: 4112).transforminverify/guards/faults/*.tomlwhosefilethis PR edits): none exist, so no anchor can go stale.mise run pr-body:check -- --body <this body>: EXIT=0.mise run checkwas not run: no.py,.toml,.rs,.tfor.ymlfile,AGENTS.md,CONTRIBUTING.mdor the PR template changed.Guards
None: this adds no guard.
Follow-ups
docs/insights/tech-debt.mditems 5 and 10, and their "Shows up in" bullets (lines 25, 30, 89, 93, 94, 123, 129), describe debt that is fixed: Pin release build tools and validate tag inputs #576 pinned@napi-rs/cli@3.8.2in.config/mise/tasks/contracts.toml:275and:305and inbindings/microvms-js/package.json:53, and docs: align source notes and CLI installation with current APIs #579 rewrote the lifecycle module docs aroundSandbox::adopt(crates/microvms-cli/src/commands/lifecycle.rs:6-13).docs/insights/debugging-guide.md:97-100warns aboutServeappearing not to implementFuture, but Bound daemon hooks, connections, and archive replacement #583 replaced theaxum::servecall with its own hyper accept loop (crates/agentd/src/serve.rs:19-71,serve_connectionat:52), so theServefuture the entry names no longer exists.crates/microvms-cli/src/commands/lifecycle.rs:2009still mentions "the module docs' assessment of aSandbox::attachconstructor", which those docs no longer contain (source comment, not docs).Platform claims
Scope
(see
docs/STRATEGY.md).