Skip to content

docs: rewrite README, update AGENTS.md, add 8 examples#87

Open
cagataycali wants to merge 3 commits intostrands-labs:mainfrom
cagataycali:docs/readme-examples
Open

docs: rewrite README, update AGENTS.md, add 8 examples#87
cagataycali wants to merge 3 commits intostrands-labs:mainfrom
cagataycali:docs/readme-examples

Conversation

@cagataycali
Copy link
Copy Markdown
Member

TL;DR

Complete documentation rewrite and 8 new examples covering simulation, hardware, and policy execution.

⚠️ Depends on: PR #86 (Robot factory) — merge last

What changed

File What
README.md Complete rewrite: 5-line promise, mermaid architecture diagram, installation extras, sim quickstart, policy examples
AGENTS.md Updated project structure with simulation modules, conventions
examples/01_sim_quickstart.py 5-line sim quickstart
examples/02_sim_agent.py Agent + simulation integration
examples/03_sim_recording.py Dataset recording to LeRobot format
examples/04_real_hardware.py Real hardware robot setup
examples/05_real_groot_policy.py GR00T policy on real hardware
examples/06_list_robots.py Robot discovery and listing
examples/act_policy_simulation.py ACT policy in MuJoCo sim with video
examples/physics_agent.py Natural language → physics introspection

No code changes

Docs and examples only. All 357 tests still pass.


Part 6 of 6 — final PR in the MuJoCo simulation decomposition

Full PR chain:

  1. fix: auto-adapt LeRobot state dimension instead of raising ValueError #82 — 🐛 LeRobot state dim fix
  2. chore: modernize build system — uv lockfile, Python >=3.12 #83 — 🔧 Build system (uv, py3.12, [sim])
  3. feat: simulation foundation — models, ABC, factory, model registry, assets #84 — 📐 Simulation foundation (models, ABC, registry)
  4. feat: MuJoCo simulation backend — AgentTool with 35 actions #85 — 🎮 MuJoCo backend (AgentTool, 35 actions)
  5. feat: Robot() factory + top-level lazy imports #86 — 🏭 Robot() factory
  6. docs: rewrite README, update AGENTS.md, add 8 examples #87 — 📖 Docs & examples (this PR)

Comment thread examples/act_policy_simulation.py
Comment thread examples/01_sim_quickstart.py Outdated
@cagataycali cagataycali force-pushed the docs/readme-examples branch 3 times, most recently from 3b633c9 to 21247ce Compare April 1, 2026 20:15
Copy link
Copy Markdown

@yinsong1986 yinsong1986 left a comment

Choose a reason for hiding this comment

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

All review comments addressed. LGTM.

@cagataycali cagataycali force-pushed the docs/readme-examples branch from 21247ce to 910a3f6 Compare April 1, 2026 20:24
Comment thread pyproject.toml
Comment thread pyproject.toml
@cagataycali
Copy link
Copy Markdown
Member Author

📋 Review Status Summary

Hi @awsarron — quick status check on this docs PR.

Thread Resolution: ✅ 4/4 resolved

All 4 review threads from @yinsong1986 are resolved:

  • Mock policy fallback for quickstart example ✅
  • Emoji rendering in print statements ✅
  • simsim-mujoco naming in install commands ✅
  • strands-robots[sim]strands-robots[sim-mujoco] naming ✅

Reviews

CI: ✅ Passing

Merge readiness

This is a docs-only PR (README rewrite, AGENTS.md update, 8 examples) with zero code dependencies. It's the lowest-risk PR in the queue and can merge independently at any time.

Note: This PR also addresses the env var documentation that was requested in PR #86's unresolved thread — merging this first would resolve that cross-PR dependency.


🤖 Automated review triage by Strands Agents. Feedback welcome!

Comment thread examples/02_sim_agent.py
@cagataycali cagataycali moved this from In progress to In review in Strands Labs - Robots Apr 16, 2026
@cagataycali cagataycali requested a review from awsarron April 17, 2026 16:30
@cagataycali cagataycali modified the milestones: v0.4.0, v0.3.9 Apr 21, 2026
cagataycali and others added 3 commits April 23, 2026 00:28
- README.md: Complete rewrite with 5-line promise, mermaid architecture
  diagram, installation extras table, simulation quickstart, policy
  execution examples
- AGENTS.md: Updated project structure to include simulation modules,
  test instructions, and conventions
- examples/01_sim_quickstart.py: 5-line sim quickstart
- examples/02_sim_agent.py: Agent + simulation integration
- examples/03_sim_recording.py: Dataset recording to LeRobot format
- examples/04_real_hardware.py: Real hardware robot setup
- examples/05_real_groot_policy.py: GR00T policy on real hardware
- examples/06_list_robots.py: Robot discovery and listing
- examples/act_policy_simulation.py: ACT policy in MuJoCo sim
- examples/physics_agent.py: Natural language physics introspection
- ACT example now documents mock provider as lightweight alternative
- Quickstart uses ASCII instead of emoji for terminal compatibility
Explain what Robot('so100') does internally: mode detection, backend
selection, Simulation construction, add_robot() call, and asset
auto-download. Addresses yinsong1986 review feedback.
@cagataycali cagataycali force-pushed the docs/readme-examples branch from 8941793 to 914cbd7 Compare April 23, 2026 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

2 participants