-
Notifications
You must be signed in to change notification settings - Fork 0
docs: update transports documentation #1107
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
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
…odule examples - Add encode/decode mixins section with PickleEncoderMixin, LCMEncoderMixin, JpegEncoderMixin - Add working example of deploying modules with shared memory transport - Add ROS and DDS to available transports table - Add doclinks CLI entry point to pyproject.toml - Fix webcam.py to import CameraInfo from dimos.msgs (has with_ts method) instead of dimos_lcm
Greptile OverviewGreptile SummaryThis PR reorganizes and significantly improves the transports documentation, consolidates files into better locations, and adds a new documentation link management tool. Major changes:
Issues found:
Confidence Score: 3/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant Doc as Documentation
participant Code as Code Files
participant Assets as Asset Files
Dev->>Doc: Update transports.md with restructured content
Dev->>Doc: Add abstraction layers section
Dev->>Assets: Add abstraction_layers.svg
Dev->>Assets: Add lcmspy.png
Dev->>Assets: Add pubsub_benchmark.png
Note over Doc: Reference go2_basic.svg (missing!)
Note over Doc: Duplicate abstraction_layers.svg twice
Dev->>Doc: Move data.md to api/data.md
Dev->>Doc: Move README_BLUEPRINTS.md to concepts/blueprints.md
Dev->>Code: Update webcam.py imports
Code->>Code: Replace dimos_lcm.CameraInfo with dimos.msgs.sensor_msgs.CameraInfo
Dev->>Code: Add doclinks CLI tool
Code->>Doc: New tool for managing markdown links
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2 files reviewed, 2 comments
paul-nechifor
previously approved these changes
Jan 25, 2026
paul-nechifor
previously approved these changes
Jan 25, 2026
paul-nechifor
approved these changes
Jan 25, 2026
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.
No description provided.