Skip to content

Conversation

@leshy
Copy link
Contributor

@leshy leshy commented Jan 24, 2026

No description provided.

leshy added 7 commits January 24, 2026 15:46
…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-apps
Copy link

greptile-apps bot commented Jan 24, 2026

Greptile Overview

Greptile Summary

This PR reorganizes and significantly improves the transports documentation, consolidates files into better locations, and adds a new documentation link management tool.

Major changes:

  • Rewrote docs/concepts/transports.md with clearer structure, better explanations, and practical examples
  • Added visual assets (abstraction_layers.svg, lcmspy.png, pubsub_benchmark.png) to improve documentation clarity
  • Reorganized documentation files: moved data.md to docs/api/ and README_BLUEPRINTS.md to docs/concepts/blueprints.md
  • Cleaned up import in webcam.py to use dimos.msgs.sensor_msgs.CameraInfo instead of dimos_lcm.sensor_msgs.CameraInfo
  • Added doclinks CLI tool for managing markdown reference links

Issues found:

  • Broken link: go2_basic.svg is referenced but not included in the PR
  • Duplicate image: abstraction_layers.svg appears twice consecutively (lines 74-76)

Confidence Score: 3/5

  • This PR has documentation issues that need fixing but no critical code problems
  • The PR makes valuable improvements to documentation structure and organization. The code change (import cleanup in webcam.py) is safe and correct. However, there are two documentation issues that need to be resolved: a broken image link to go2_basic.svg that doesn't exist, and a duplicate image reference. These are straightforward to fix but should be addressed before merging since they affect the documentation quality. The doclinks CLI tool addition is a useful utility for maintaining documentation links.
  • Pay close attention to docs/concepts/transports.md - fix the missing go2_basic.svg reference and remove the duplicate image on line 76

Important Files Changed

Filename Overview
dimos/hardware/sensors/camera/webcam.py Updated import to consolidate CameraInfo from dimos.msgs.sensor_msgs (removed dimos_lcm dependency)
docs/concepts/transports.md Major documentation rewrite with improved structure and examples, but contains broken link to go2_basic.svg and duplicate image reference
pyproject.toml Added new CLI entry point doclinks for markdown link management tool

Sequence Diagram

sequenceDiagram
    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
Loading

Copy link

@greptile-apps greptile-apps bot left a 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

Edit Code Review Agent Settings | Greptile

@leshy leshy changed the title WIP Docs/transports update alt docs/transports Jan 24, 2026
@leshy leshy changed the title docs/transports docs: update transports documentation Jan 24, 2026
paul-nechifor
paul-nechifor previously approved these changes Jan 25, 2026
paul-nechifor
paul-nechifor previously approved these changes Jan 25, 2026
@leshy leshy merged commit f6264c1 into dev Jan 25, 2026
15 checks passed
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.

3 participants