Skip to content

docs: update transforms 3D-viz instructions for rerun#2156

Closed
JoeCardoso13 wants to merge 1 commit into
dimensionalOS:mainfrom
JoeCardoso13:docs/transforms-rerun-bridge
Closed

docs: update transforms 3D-viz instructions for rerun#2156
JoeCardoso13 wants to merge 1 commit into
dimensionalOS:mainfrom
JoeCardoso13:docs/transforms-rerun-bridge

Conversation

@JoeCardoso13
Copy link
Copy Markdown

@JoeCardoso13 JoeCardoso13 commented May 18, 2026

Problem

docs/usage/transforms.md carried an inline (TODO we need to update this for rerun). The 3D-visualization instructions still told readers to use foxglove-studio-bridge / foxglove-studio, but Rerun is now the default viewer backend. No tracked issue — this resolves the in-doc TODO directly.

Solution

Replaced the Foxglove instructions with the direct Rerun equivalent, dimos rerun-bridge. This works end-to-end with no other changes: TFMessage.to_rerun() maps each transform to the world/tf/<child_frame_id> entity path, and the default Rerun blueprint roots its Spatial3DView at world, so the example's transform tree renders automatically. Added a note to start the bridge before the example (it runs briefly; TF buffer is short-lived). Scoped to the TODO line; the existing screenshot asset is left untouched.

How to Test

In one terminal: dimos rerun-bridge; then run the multi-module example from the doc — the world/tf/* frames render in the Rerun 3D view.

Contributor License Agreement

  • I have read and approved the CLA.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 18, 2026

Greptile Summary

Replaces the stale Foxglove-Studio 3D-visualization instructions (and their inline TODO) in docs/usage/transforms.md with the equivalent Rerun workflow (dimos rerun-bridge). No code is changed.

  • The old paragraph pointing readers to foxglove-studio-bridge / foxglove-studio is replaced by a short dimos rerun-bridge bash snippet and a note to start the bridge before running the example.
  • The description accurately reflects the implementation: TFMessage.to_rerun() publishes at world/tf/<child_frame_id>, and the default blueprint roots its Spatial3DView at world, so the tree appears automatically.

Confidence Score: 5/5

Documentation-only change with no code modifications; safe to merge.

The change removes a stale TODO and Foxglove paragraph, replacing it with a verified Rerun workflow. The entity path (world/tf/<child_frame_id>) and the blueprint's Spatial3DView origin (world) both match the live source code, and dimos rerun-bridge is a registered CLI entry point in pyproject.toml. There is nothing to break.

No files require special attention.

Important Files Changed

Filename Overview
docs/usage/transforms.md Documentation-only update: replaces Foxglove 3D-viz paragraph with Rerun equivalent; entity path and blueprint root claims verified against source.

Sequence Diagram

sequenceDiagram
    participant User
    participant Terminal1 as Terminal 1
    participant Terminal2 as Terminal 2
    participant RerunBridge as dimos rerun-bridge
    participant RerunViewer as Rerun Viewer
    participant Example as Multi-Module Example
    participant LCM as LCM Bus

    User->>Terminal1: dimos rerun-bridge
    Terminal1->>RerunBridge: start bridge
    RerunBridge->>RerunViewer: open viewer (Spatial3DView rooted at world)
    RerunBridge->>LCM: subscribe to TF topic

    User->>Terminal2: run multi-module example
    Terminal2->>Example: execute
    Example->>LCM: self.tf.publish() → TFMessage
    LCM->>RerunBridge: deliver TFMessage
    RerunBridge->>RerunViewer: "log world/tf/<child_frame_id> entities"
    RerunViewer-->>User: renders transform tree in 3D
Loading

Reviews (1): Last reviewed commit: "docs: update transforms 3D-viz instructi..." | Re-trigger Greptile

Copy link
Copy Markdown
Contributor

@leshy leshy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi, did you actually test this? would be nice to add screenshot

@JoeCardoso13
Copy link
Copy Markdown
Author

Closing — this was overtaken by #2122 (DIM-877), which removed Foxglove support entirely and replaced this same paragraph with a link to docs/usage/visualization.md. The TODO this PR was resolving is gone from main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants