Skip to content

fix(docs): docs/readme additions#1527

Merged
spomichter merged 3 commits intodevfrom
docs/readme-additions
Mar 11, 2026
Merged

fix(docs): docs/readme additions#1527
spomichter merged 3 commits intodevfrom
docs/readme-additions

Conversation

@spomichter
Copy link
Contributor

@spomichter spomichter commented Mar 11, 2026

Problem

Closes DIM-XXX

Solution

Breaking Changes

How to Test

Contributor License Agreement

  • I have read and approved the CLA.

@spomichter spomichter changed the title Docs/readme additions fix(docs): docs/readme additions Mar 11, 2026
@spomichter spomichter merged commit 8748352 into dev Mar 11, 2026
2 checks passed
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 11, 2026

Greptile Summary

This PR makes three targeted documentation improvements to README.md:

  • Adds a new dimos run demo-camera entry to the blueprint quick-start table, giving users a hardware-free entry point to try the framework.
  • Clarifies that dimos run keyboard-teleop-xarm7 requires the dimos[manipulation] optional extra, which is accurate given its dependency on dimos.manipulation.* modules.
  • Corrects the CLI usage example in the Agent CLI and MCP section from unitree-go2-agentic to unitree-go2-agentic-mcp, which is the appropriate blueprint for demonstrating MCP server functionality.

All three referenced blueprints (demo-camera, keyboard-teleop-xarm7, unitree-go2-agentic-mcp) are confirmed to exist in dimos/robot/all_blueprints.py. No logic or code changes are introduced.

Confidence Score: 5/5

  • This PR is safe to merge — it contains only documentation corrections with no code changes.
  • All changes are factually accurate (verified against all_blueprints.py), improve user-facing clarity, and carry zero risk of breaking existing functionality.
  • No files require special attention.

Important Files Changed

Filename Overview
README.md Three small documentation improvements: adds the demo-camera blueprint row, clarifies the keyboard-teleop-xarm7 extra dependency, and corrects the CLI example to use unitree-go2-agentic-mcp. All referenced blueprints confirmed to exist in all_blueprints.py.

Sequence Diagram

sequenceDiagram
    participant User
    participant CLI as dimos CLI
    participant Blueprint as Blueprint Runner

    User->>CLI: dimos run demo-camera
    CLI->>Blueprint: Load demo_camera blueprint
    Blueprint-->>User: Webcam stream (no hardware needed)

    User->>CLI: dimos run keyboard-teleop-xarm7
    CLI->>Blueprint: Load keyboard_teleop_xarm7 blueprint
    Note over Blueprint: Requires dimos[manipulation] extra
    Blueprint-->>User: Keyboard teleop UI + mock xArm7

    User->>CLI: dimos run unitree-go2-agentic-mcp --daemon
    CLI->>Blueprint: Load unitree_go2_agentic_mcp blueprint
    Blueprint-->>User: Go2 agentic + MCP server running in background
    User->>CLI: dimos agent-send "explore the room"
    CLI->>Blueprint: Forward command to agent
    Blueprint-->>User: Agent executes command
Loading

Last reviewed commit: 308e5e0

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.

1 participant