Skip to content

docs: reorganize Go2 platform docs + map framing default#2566

Open
jeff-hykin wants to merge 5 commits into
mainfrom
jeff/feat/go2_docs
Open

docs: reorganize Go2 platform docs + map framing default#2566
jeff-hykin wants to merge 5 commits into
mainfrom
jeff/feat/go2_docs

Conversation

@jeff-hykin

@jeff-hykin jeff-hykin commented Jun 23, 2026

Copy link
Copy Markdown
Member

Move premap stuff to go2 since its go2 specific. Touch up go2 docs.

@greptile-apps

greptile-apps Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR reorganizes the Unitree Go2 documentation from a single large page into focused sub-pages (setup, simulation, premap), and changes the dimos map CLI default from body-frame to world-registered (Go2/fastlio) operation, replacing the --go2 flag with --use-tf for the non-default case.

  • Docs restructure: index.md becomes a hub; content is split into setup.md, simulation.md, and premap.md. All three sub-pages are now listed in docs.json so they appear in the sidebar.
  • CLI flag rename: --go2 is replaced by --use-tf (inverted semantics); the _accumulate function's world_frame default flips from False to True, making world-registered clouds the default for all three call sites.
  • Recording fix: Go2Memory gains explicit @pose_setter_for methods so odom and lidar frames are anchored using the live odometry pose rather than a tf-tree lookup.

Confidence Score: 5/5

Safe to merge — the code changes are small and internally consistent, and the docs reorganization is additive.

The CLI default flip is intentional and consistently applied across all three _accumulate call sites. The new @pose_setter_for methods follow the documented pattern in the Recorder base class and the PoseStamped-extends-Pose relationship makes the return types valid. The documentation changes correctly address the previously flagged missing docs.json entries, and all referenced installation files exist. No functional regressions were found.

No files require special attention.

Important Files Changed

Filename Overview
dimos/mapping/utils/cli/map.py Renames --go2 flag to --use-tf with inverted semantics and flips world_frame default from False to True; all three _accumulate call sites updated consistently to world_frame=not use_tf.
dimos/robot/unitree/go2/blueprints/smart/unitree_go2.py Adds explicit @pose_setter_for methods so the odom stream records its own pose and the lidar stream borrows the latest odom pose; PoseStamped extends Pose so the return types are valid.
docs/docs.json Expands the flat platforms/quadruped/go2/index entry into a nested Unitree Go2 group containing all four sub-pages, making them fully discoverable in the sidebar.
docs/platforms/quadruped/go2/index.md Converted from a long monolithic guide into a concise hub page linking to the three new sub-pages; blueprint table updated with runnable dimos run commands.
docs/platforms/quadruped/go2/setup.md New page split from the old index, covering requirements, install, first-time WiFi setup, pre-flight checks, running DimOS, and agentic control; all referenced installation links resolve correctly.
docs/platforms/quadruped/go2/premap.md Renamed from capabilities/mapping/relocalization.md and updated to use the new dimos map global subcommand; all four example invocations correctly omit the deprecated --go2 flag (now the default behavior).
docs/platforms/quadruped/go2/simulation.md New page split from the old index covering the replay and MuJoCo simulation paths; content is accurate and concise.

Reviews (3): Last reviewed commit: "-" | Re-trigger Greptile

Comment thread docs/platforms/quadruped/go2/index.md
Comment thread dimos/mapping/utils/cli/map.py
@codecov

codecov Bot commented Jun 23, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 70.00000% with 3 lines in your changes missing coverage. Please review.
✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
.../robot/unitree/go2/blueprints/smart/unitree_go2.py 70.00% 3 Missing ⚠️
@@            Coverage Diff             @@
##             main    #2566      +/-   ##
==========================================
- Coverage   69.59%   69.59%   -0.01%     
==========================================
  Files         878      878              
  Lines       79311    79320       +9     
  Branches     7126     7126              
==========================================
+ Hits        55200    55206       +6     
- Misses      22310    22314       +4     
+ Partials     1801     1800       -1     
Flag Coverage Δ
OS-ubuntu-24.04-arm 62.99% <70.00%> (+<0.01%) ⬆️
OS-ubuntu-latest 65.82% <70.00%> (+<0.01%) ⬆️
Py-3.10 65.82% <70.00%> (+<0.01%) ⬆️
Py-3.11 65.82% <70.00%> (+0.01%) ⬆️
Py-3.12 65.82% <70.00%> (+<0.01%) ⬆️
Py-3.13 65.82% <70.00%> (+<0.01%) ⬆️
Py-3.14 65.83% <70.00%> (+<0.01%) ⬆️
Py-3.14t 65.82% <70.00%> (+<0.01%) ⬆️
SelfHosted-Linux 37.80% <70.00%> (-0.01%) ⬇️
SelfHosted-macOS 36.59% <70.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
dimos/mapping/utils/cli/map.py 38.88% <ø> (-2.23%) ⬇️
.../robot/unitree/go2/blueprints/smart/unitree_go2.py 92.50% <70.00%> (-7.50%) ⬇️

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions github-actions Bot added the ready-to-merge Required CI checks have passed on this PR label Jun 23, 2026
@github-actions github-actions Bot added ready-to-merge Required CI checks have passed on this PR and removed ready-to-merge Required CI checks have passed on this PR labels Jun 23, 2026
@github-actions github-actions Bot removed the ready-to-merge Required CI checks have passed on this PR label Jun 23, 2026
@jeff-hykin jeff-hykin enabled auto-merge (squash) June 23, 2026 10:07
@github-actions github-actions Bot added the ready-to-merge Required CI checks have passed on this PR label Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-to-merge Required CI checks have passed on this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant