Repository navigation
docs: re-point the source citations #600 and #601 moved - #612
Merged
Merged
Conversation
604 path:line citations on 15 hand-written pages pointed a few lines off after #600 and #601 moved their source lines. Each move is the doc line's blame-commit block found at HEAD by exact text and by git's own diff line mapping, or a read-only audit against the sentence for the 20 rows neither settled. state-machines.md's VmState section now says what ResumeRequested does after SuspendedVmEnded (client.rs:494-499, 509-512): the service refuses the request and the model writes Terminated.
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
#600 (e209162) and #601 (a4047ea) moved lines in the source files the hand-written pages cite, so 604
path:linecitations on 15 pages pointed a few lines off while still resolving, whichdocs:checkcannot see. This re-points them, and rewords one sentence ondocs/behavior/state-machines.mdthat #601 made incomplete. The branch starts from main at 8797176; only Markdown underdocs/changes.How each move was found
For every citation,
evidence/blame-shift-citations-2026-10-12.py(in the nightly job's workspace) takes the doc line'sgit blamecommit as its baseline, reads the cited block there, and looks for the same text at HEAD. It reported 645 citations whose block is no longer at the cited lines: 353 with one exact match elsewhere, 240 with several, and 52 with none.Each match was then checked against git's own line mapping:
git diff -U0 <baseline> HEAD -- <file>hunks map every cited line that sits outside a changed hunk to its HEAD line. A citation moves here only when that mapped range is one of the exact-text matches; that settled 592 rows, including 239 of the 240 with several matches (mostly#[arg(long)]lines incli.rs). The oneCONTRIBUTING.md:133row is an examplemutants.outline, not a citation, and stays.The 53 rows without a settled match got two passes. Comparing with version numbers normalized cleared 29
Cargo.tomlrows whose cited lines are right and only carry the 1.0.1 version. A read-only audit of 20 others, against each doc sentence, found 7 still right, 12 moved, and 1 contradicted. The last 4 aredebugging-guide.mdrows (commands/local.rs:47-68,:52-58,main.rs:22-24) whose cited text no longer matches; they were already flagged on 2026-10-12, and each needs its sentence checked against the code, which this change doesn't attempt.Moves by page
docs/reference/cli.mddocs/behavior/processes.mddocs/insights/contract-map.mddocs/insights/impact-analysis.mddocs/behavior/state-machines.mddocs/diagrams/behavioral/sequences.mddocs/diagrams/architecture/components.mddocs/reference/public-api.mddocs/architecture/system-overview.mddocs/insights/business-logic.mddocs/reference/rpc-tools.mddocs/architecture/data-flow.mddocs/analysis/risk-hotspots.mddocs/analysis/dead-code.mddocs/diagrams/structural/dependency-graph.mdMost cite
crates/microvms-cli/src/cli.rs(386),crates/microvms-app/src/sandbox.rs(80) andcrates/microvms-app/src/session/mod.rs(44). Oncli.md, each moved flag citation's HEAD line was read back: 368 of 373 land on the#[arg]of a field whose name is the flag the bullet names, and the other five are right too: four flags whose field is spelled differently (--tagistags,--forisfor_sec,--egress-network-connectorisegress_network_connectorstwice), and--identity-host-seed, whose citation is the field's "Prefer --from or --identity-host-seed-file." doc line (cli.rs:1991) that the bullet paraphrases.The reworded sentence
state-machines.md's VmState section said "ResumeRequestedpreservesSuspendedwhile recording an in-flight resume." Since #601,ResumeRequestedfromSuspendeddoes that only until the newSuspendedVmEndedaction has setplatform_ended(crates/model/src/client.rs:509-512); after it, the request writesVmState::Terminatedandwas_terminatedand returnsVerdict::RefusedByService(crates/model/src/client.rs:494-499). The sentence now states both cases, and its range follows the verdict match toclient.rs:390-532.Unverified: the VmState diagram below that sentence has no
SuspendedVmEndededge; whether the diagram should show the platform-ended path is a modeling choice this change leaves alone.Evidence
mise run docs:checkon this branch: EXIT=0 in 169 s;astro check0 errors and 0 warnings over 54 files, and vitest 15 files, 223 tests passed.mise run prose:checkon this branch: EXIT=0 in 37 s, "Prose: 0 errors, 4069 warnings, 0 suggestions."tools/prose.py --linton main and on this branch lists the same warnings for every file and rule, so no ceiling in.vale/warnings.jsonmoves.transforminverify/guards/faults/*.tomlnames an edited file.moves-verify-2026-10-14.txt,moves-audited-verify-2026-10-14.txtin the job's evidence directory); a 14-row sample outsidecli.mdand all 13 audited moves were read by hand.mise run pr-body:check -- --body <this body>: EXIT=0.mise run check: not run; this changes only Markdown underdocs/, andprose:checkis thechecktier that reads it.Guards
None: this adds no guard.
Follow-ups
docs/insights/debugging-guide.md:31,:44,:48and:60citecrates/microvms-cli/src/commands/local.rs:47-68,:52-58andcrates/microvms-cli/src/main.rs:22-24, whose text changed after the page's baseline; each needs its sentence checked against the code.state-machines.mdhas no edge forSuspendedVmEndedor the refused resume it leads to.Platform claims
Scope
(see
docs/STRATEGY.md).