Repository navigation
reference(digital-twin): Digital Twin handbook with a CI-checked quick start - #95
Draft
BotshareAI wants to merge 3 commits into
Draft
BotshareAI wants to merge 3 commits into
BotshareAI wants to merge 3 commits into
Conversation
…ess quick start The digital-twin-quickstart workflow extracts every bash block marked quickstart:headless from install-and-run.md and runs them in page order with set -eo pipefail; a page with no marked block fails. Signed-off-by: Alex Reznichenko <[email protected]> Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01DZnPEMPDB6f8AohTTfGWkF
…o the published sources Landing page as the single entry point; new pages for architecture and data flow, physics model, electronics and CAN, firmware, ROS 2 graph, simulators, operator UI and Control Room, scenarios, faults, evidence and limits with release and versioning. Status and architecture brought to 20 Nov 2026; obsolete #70 commands and pending demo-document notes replaced by links; simulation framework pages point to the handbook. Mermaid fences enabled. Quick start: source ROS 2 after the installs so gz is on the path (found by the quick-start job, run 44798734068). Signed-off-by: Alex Reznichenko <[email protected]> Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01DZnPEMPDB6f8AohTTfGWkF
…rk, Isaac kit, UI twin run Simulators: lock update #104, parity 2922 checks with 0 failures, the 21 declared deviations of upperbody-sw #96, the #106 benchmark (12 of 21 metrics within tolerance, causes, Gazebo lift row under investigation), reproduction commands, and that direct /cmd_vel is for the isolated physics benchmark only; Isaac GPU run kit #107. Operator UI: #62 twin run 44806541459 (browser 8/8, probe 11/11). Evidence: diagnostic leg 44808492353; strict acceptance not run yet. Quick start: stop the background launch with SIGTERM and a bounded wait (SIGINT is ignored by a background job; run 44800007695 hung there after blocks 1 to 5 passed). Signed-off-by: Alex Reznichenko <[email protected]> Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01DZnPEMPDB6f8AohTTfGWkF
BotshareAI
requested review from
anandgawai123456-glitch and
panthera-momagdii
November 20, 2026 23:38
This branch has not been deployed
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.
Digital Twin handbook for OpenAMRobot 2.0 (Digital Twin release candidate, gate RC-F). Stacked on #93 (base
docs/grocery-demonstrator0d6596e, which carries #91). Primary audience: developers and integrators, including engineers who are not robotics specialists.Work package
DT-RC worker S6: Digital Twin handbook in openamrobot-docs (gate RC-F, criteria F1, F6, F7, F8 and the documentation verification).
What changes
reference/openamrobot-2/digital-twin/index.mdrewritten as the handbook landing page (what the twin is, a "start here" table to every page, L1 to L6 and F0 to F3 kept word for word).docs/demo/can_signal_paths.mdand #168), firmware and message flow (host stand-in vs Renode telemetry image vs fw docs: adopt documentation information architecture #22; SDO, PDO, heartbeats), ROS 2 graph (command chain today and with platform-sw docs: record merged roadmap pins and superseded E-01 baseline #90; Nav2, MoveIt, ros2_control), simulators (Gazebo, MuJoCo parity and the 21 declared deviations of upperbody-sw docs: index the shared interface packages and navigation messages #96, the Gazebo vs MuJoCo benchmark of #106 with causes and reproduction, Isaac GPU run kit #107, RViz), operator UI and Control Room (Roadmap: 9 Nov 2026 refresh, model visuals, exploded tour and every page #84, ui [audit] Register alignment: documentation current-branch mismatches #50, roadmap: upper-body layout of 28 Oct (second E-stop on the column, Getac and head light, head camera forward and hp30), lift stop sensors, one model on both pages, all media re-rendered #62 and run 44806541459), scenarios (Baseline 1, grocery demonstration, AI recording and conversion as development evidence), faults and fault injection, evidence and limits (runs, reproduction, fidelity assumptions, known limitations, rc.1 source pre-release vs Digital Twin RC).customize/simulation/index.md,gazebo-setup.mdand the browserdark-store-simulation.mdnow point to the handbook.digital-twin-quickstartworkflow.scripts/digital_twin_quickstart.pyextracts every bash block marked<!-- quickstart:headless -->on the install page, in page order, and runs them as one script withset -eo pipefail; no marked block fails. Tests inscripts/tests/test_digital_twin_quickstart.py(also run by the existing Documentation job).mkdocs.yml: nav entries; Mermaid custom fence forpymdownx.superfences. STATE.md and CHANGELOG.md entries.No BOM, interface definition or configuration register is copied; pages link the owning files at commits. The direct
/cmd_veluse of the #106 benchmark is stated as isolated physics benchmarking only; whole-robot acceptance uses the approved command chain. The Gazebo lift benchmark row is marked under investigation.Integration Gate
digital-twin/.baseline1-acceptance.yml,config/pins.yaml,docs/integration/baseline1.mdat upperbody-sw 196dd3f;sil_fidelity.md(#168 52c64da);parameter_register.yaml(docs: describe how OpenAMRobot releases are built and verified #97);can_signal_paths.mdandcontrol_room.md(Roadmap: 9 Nov 2026 refresh, model visuals, exploded tour and every page #84);docs/simulators.md(roadmap: model call to action and link preview tags on the overview page #69); benchmark and Isaac kit (#106, #107); platform-sw docs: record merged roadmap pins and superseded E-01 baseline #90navigation_launch.pyandtwist_mux.yaml(2dd1c74).Tests
python3 -m unittest scripts/tests/test_digital_twin_quickstart.py: 10 tests OK. They fail on revert: droppingpipefailor-ein the generated header failstest_failure_inside_a_pipeline_fails_the_script/test_failing_command_fails_the_script; removing the markers failstest_install_page_has_the_quick_start.gz: command not found(ROS sourced before the vendor packages were installed). Fixed in the page./sil/drive/status,/clock, all/sil/*device topics), then hung: a background job ignores SIGINT. Cancelled at the 180 min limit. Fixed (SIGTERM and a bounded wait).firmware_siltwin with device topics,scn14_drive_fastPASS.mkdocs build --strictrc 0; internal link and anchor check of the twin pages and the three redirected pages: 2271 links, 0 broken;scripts/check_docs.shpassed;scripts/check_roadmap.pypassed;python3 -m unittest discover -s scripts/testsOK;tests/test_live_site.pyOK.check_public_extract.py --changed-files0 findings;check_decisions.py --changed-files0 contradictions.Evidence
Base SHA: 0d6596e (
docs/grocery-demonstrator)Head SHA: ed34b86
Commands:
integration/baseline1196dd3fe64900ba4a12124c9ee20e0cfaafa1651; platform-sw fb25be1, interfaces 50ed777, openarm pins read from that commit.Not verified
run_scenario.py, Control Room, operator UI views, Isaac kit, MuJoCo viewer): need a desktop or a GPU; covered by the desktop acceptance checklist on the install page, not run.gh workflow runreproduction command: taken frombaseline1-acceptance.yml; not run for this page (the mission runs in that workflow).sim-benchmark.ymlruns them; not run for this page.UB_SHAmoves to the strict run's commit once that verdict exists. No strict acceptance run exists yet.AI disclosure
Claude Code (Claude Opus 5.5) wrote the pages, the extractor, its tests, the workflow and the STATE/CHANGELOG lines, and checked the cited runs, PRs and files through the GitHub API. Safety path: none touched.
Publication check
No private person, customer or partner named; the application name is Use_Case_1 where needed; no internal document links, prices, contact data or credentials. Every page carries a simulation-not-hardware warning. No em dashes.
Intellectual property and provenance
Draft until the docs owner writes adopt, adapt or reject. Desktop acceptance: one reviewer runs steps 1 to 6 of the checklist, a second repeats them on another machine, a third runs steps 7 and 8 on an NVIDIA GPU machine.
https://claude.ai/code/session_01DZnPEMPDB6f8AohTTfGWkF
Generated by Claude Code