Repository navigation
docs(user-docs): re-record the handbook and reference transcripts against the pinned binaries - #1504
Merged
Merged
Conversation
…inst the pinned binaries Co-Authored-By: jason.han <hanhuijun@gmail.com>
Contributor
Author
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
4 of 6 tasks
Contributor
Author
There was a problem hiding this comment.
🔍 Devin Review: 1 flag
Not posted on this PR by your GitHub settings — view it in Devin Review. (Configure)
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
Second area of the documentation accuracy audit (the first is #1503,
examples/):README.md,docs/guide,docs/manual,docs/clientsanddocs/reference, measured against binaries built withmake buildatdevelop76c98694c(merge of #1483). Every fenced command and REPL block was replayed (per block and cumulatively per page), every fencedsysml/kermlsnippet validated standalone / wrapped / cumulative / as a part-def body, and every CLI flag,%command, environment variable, Make target, gRPC capability and-print-confighost name grepped in source or compared with the binary. Each mismatch below was reproduced on thev0.11.0release binary as well, so all of them are documentation drift, not regressions. Docs-only; no model or code moved.README.mdruntime showcasestage1DeltaV = 3037.69… [SI::'m/s'],margin = 70.65…,margin = -329.34…[3037.6966629706967 [SI::'m/s']]… (./bin/sysml -quiet -analysis DeltaVBudget::saturnIBAscent examples/runtime-showcase/delta-v-budget.sysml, and withrequired = 9800 ['m/s'])docs/guide/05-checking.md:534,6293:36: error: unresolved reference: size …,1:35: error: cannot bind …error[unresolved]: …,error[binding-connector-type-conformance]: …(REPL replay of the blocks)docs/guide/07-saving-and-rdf.md:463:3: error: expected a namespace member3:3: error[syntax]: expected a namespace memberdocs/guide/06-behavior.md:504-540(Guard::Sentry)Use %events …/Use %step …hints, no choice-point line,log = "watch;watching(exit);abort;"1 choice point; %trace on to see them, and… (order-dependent; 1 choice point — explore shows the set)(replay of the block; the page's first transcript at line 90 already shows the hint form)docs/reference/repl-commands.md:440-478, 530-556, 559-563, 623-637, 654-664anddocs/guide/04-repl.md:361-370%render Demo::summarytree/Mermaid/DOT/PlantUML/D2 with qualified names and declared types (part def Demo::Vehicle,attribute mass : Real,view Demo::summary::detail)part wheelexpanded, node ids renumbered, MermaidthemeCSS/themeVariablesfrontmatter (cumulative replay of the page'sDemopackage; identical onv0.11.0). The…elisions of the DOT/PlantUML/D2 blocks are kept; only the lines they show were re-recorded.docs/reference/java-api.md:14<version>0.10.1</version>0.11.0is on Maven Central (central.sonatype.comversions API lists0.11.0,0.10.1;client/java/pom.xmlis0.11.0;docs/guide/09-clients.mdandclient/java/README.mdalready say0.11.0)Checked and accurate (no edit):
sysml-mcp -print-configblocks for all seven hosts (byte-identical to the binary's output with-print-config-command /usr/local/bin/sysml-mcp);04-repl.md%cleardropped-instance note;repl-commands.mdquoted-name suggestion; every%command in the REPL pages is in%help; everyOPENSYSML_*variable named indocs/referenceis in source or the installer; everymaketarget named is in theMakefile; thejupyter-kernel.md0.10.0lines are illustrative, not stale.Quick-starts run against
bin/sysml-grpc(OPENSYSML_BINARY): Python (opensysml0.11.0 from PyPI), Node (@openmbee/opensysml0.11.0 from npm) and Java (mvn -f client/java/pom.xml install, then the page'sDemo.java) each print1800.0as documented. Not run: the Rust, Julia and MATLAB quick-starts.Left as written (evidence for a follow-up):
docs/guide/05-checking.md:758— the%check Box::crateUnsetwitness (height = 0.875 [metre],length = 1.09375,volume = 1.016845703125) is one z3 model among many;developwith z3 4.x prints0.9375 / 1.0625 / 1.058349609375, andv0.11.0fails the same block withvalue cannot be fixed for solving: a undetermined. Solver-dependent, so not re-recorded.docs/guide/modeling-product-lines.mdtranscripts depend on the downloaded pilot corpora and were not replayed.model.sysml,a.sysml,tmt.sysml,landing.sysml, …) cannot be replayed literally and were read instead.Coverage: fully read and replayed —
README.md,docs/guide/02,04,05,06,07,docs/reference/repl-commands.md(render section),java-api.md,sysml-mcp.md(config section),docs/clients/python/index.md,node.md,java.md; replayed and triaged by harness, prose skimmed — the remainingdocs/guide,docs/manualanddocs/referencepages; not reached beyond the names/figures grep —docs/clients/julia.md,matlab.md,rust.md,docs/reference/wire-contract.md(hash transcript, unedited).Overlap (open PRs touching
README.md): #1502 (304df41bb), #1484 (70dae7174), #1466 (e589bddc2) — each dry-merged onto this head with no conflict; none restates the showcase figures.How it was verified
At
e2db498fe(this head, ondevelop76c98694c):python3 scripts/check-doc-links.py— rc 0python3 scripts/check-doc-ids.py— rc 0python3 scripts/check-doc-figures.py— rc 0make docs-landing-assetsthenmake docs-check—0 broken link(s), rc 0python -m mkdocs build --strict— rc 0python3 scripts/changelog.py check— rc 0Checklist
make testandmake lintpass locally — docs-only change; the documentation gates above are the ones that cover itchanges/unreleased/docs-audit-user-docs.fixed.mdmake docs-countsrun if a gate count moved — no gate count moved