Repository navigation
docs(examples): re-record the example walkthroughs against the pinned binaries - #1503
Merged
Merged
Conversation
… binaries Calculation and analysis results print in their effective multiplicity, choice-point counts name the independent ones, the Mermaid frontmatter and container titles changed, a completed state machine lists under Behaviors, and the instance IDs, check-engine and -render-all figures moved. The two Python demo scripts read the one-element sequences the opensysml client returns. examples/README.md lists general-views-demo/, whose walkthrough now names the name-conflict warning its model prints, and the parser feature demos page states the current 110-file conformance figure. 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)".
|
This was referenced Oct 25, 2026
Merged
…red gate count Co-Authored-By: jason.han <hanhuijun@gmail.com>
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
Audit of everything under
examples/againstorigin/developat76c98694c(40 PRs pastv0.11.0), with binaries built from that commit bymake build. Every tracked model (44 outsideexamples/self-model/) was run through-validateand-strict; every fenced./bin/sysml,sysml,pythonand REPL block in the 20 walkthrough pages was replayed per block and cumulatively and diffed against the transcript that follows it; the inlinesysml/kermlsnippets were validated standalone, wrapped, cumulatively and as a part-def body. Each mismatch was re-run on thev0.11.0release binary before being classed as documentation drift. Docs-only edits that keep each page's voice and elisions:fuelUsed = [120.0],= [6432.955324716369 [SI::'m/s']],result = [VerdictKind::pass],selectedAlternative = [Landers::relay (object #5)],-json"value": "[240.0]",-trace-> (130.0), sweep and explore tables). Re-recorded inanalysis-demo,analysis-results-demo,runtime-showcase,disposal-robot-demo,relay-probe-demo,EXPRESSIONS-DEMO.1 choice point (1 independent),592 choice points (591 independent), the(order-dependent; 1 choice point — explore shows the set)marker onsawBraking, and the check engine's14748 states, 35626 moves(the page said 14664/35546; both binaries print 14748).themeCSS/themeVariableswithsubGraphTitleMargin.bottom: 24, container titles are written on one line, the pins notice is gone, interconnection edges are unlabelled,-render-allbyte counts moved, and a text state rendering namesstate def Modesunqualified; the filteredsafetyViewtree listspart def Thruster/part def Parachutewithout members (VIEWS-DEMO,disposal-robot-demo).%featuresof a completed state machine lists it underBehaviors:instead of<unknown>state entries,%advance 5processes 2 events,%checkof an unsatisfiable requirement prints its own verdict line before%explain, the%evalheadings and the cumulative instance IDs ofEXPRESSIONS-DEMO, and three lines-requirement … -satisfyno longer prints indisposal-team-demo.lander_demo.pyandrobot_demo.pycrashed onv0.11.0anddevelopalike (TypeError: unsupported format string passed to list.__format__): theopensysml0.11.0 client returns the one-element sequences the service now sends. They index the single element and their transcripts carry the— observed by run/— witnessed by runsuffixes. This is the one non-Markdown change; the models are untouched, so the pilot differential baseline does not move.examples/README.mdgains thegeneral-views-demo/row it lacked and namesgridview-relationship-matrix.sysml;general-views-demo/README.mdnames thename-conflictwarningvehicle.sysml:102prints on every command;PARSER_FEATURES_DEMOS.mdno longer restates the parser gate's count (it said96/96, "94 + two extensions"; the gate is at110/110) and links the roadmap's gate table instead, per CONTRIBUTING's "measured numbers have one home", and drops the development-session and task labels CONTRIBUTING forbids in reader-facing text.Out of scope and untouched:
examples/self-model/and its tests.Product gaps found (not papered over)
%instantiate mission/%features missioninrelay-probe-demoprintssubitems: <error: subsetting feature subparts of subitems: occurrence lifetime does not admit the change: cruise #3 would hold cruise #3, a whole it is a portion of, as a portion of itself>for the timeslice (both binaries); the page elides that region with....fuel left [130.0] kg): the scripts now unwrap, but a scalar-valuedoutparameter arriving as a list is worth a client-side decision.A stale-records regression first listed here (
-record-runemptying the Runs that no longer match the model table) did not reproduce on a cleanmake buildof76c98694c— the renders with and without-record-runboth listrelayRun; the earlier observation came from a-dirtyworking-tree binary and is withdrawn.Overlap
Open PRs touching
examples/: #1502 (docs/self-model-surfaces-refresh@304df41bb), #1484 (fix/part-usage-part-definition-reading@70dae7174), #1477 (feat/document-whole-bodies@2672d357c) — all only underexamples/self-model/; each dry-merges cleanly against this head, as doesorigin/developat76c98694c.How it was verified
At
a5892bc02:python3 scripts/check-doc-links.py→0 broken link(s);python3 scripts/check-doc-ids.py→No internal work-item labels…;python3 scripts/check-doc-figures.py→ ok;python3 scripts/changelog.py check→ rc 0make docs-landing-assets→ rc 0;make docs-check→0 broken link(s), rc 0;python -m mkdocs build --strict→ rc 0go test -count=1 ./examples/ ./tests/hygiene/→ ok, okgo test -run TestStdlibConformance ./internal/workspace/libs→110/110 clean./bin/sysmlat76c98694c;lander_demo.pyoutput is byte-identical to its README block,robot_demo.pydiffers only in the elided condition text; both run againstbin/sysml-grpcviaOPENSYSML_BINARY.Checklist
make testandmake lintpass locally — docs and example-script change; the gates above ranchanges/unreleased/docs-audit-examples.fixed.mdmake docs-countsrun if a gate count moved — no gate count moved