docs(readme): nav description, quickstart with real examples, remove dead perception link by spomichter · Pull Request #1301 · dimensionalOS/dimos

spomichter · 2026-02-19T12:17:58Z

Summary

Navigation description: "ROS and Native" → "SLAM, dynamic obstacle avoidance, route planning, and autonomous exploration — supported on native DimOS and ROS"
Perception: removed dead # video link, updated subtitle
Renamed "Use DimOS as a library / UI" → Quickstart
Quickstart now has real working examples:
- dimos[base,unitree] with --replay + LFS download warning
- dimos[base,unitree,sim] with --simulation + DISPLAY/warp warnings
- Real robot with ROBOT_IP export
Dev section: replaced duplicate replay with --simulation example

greptile-apps · 2026-02-19T12:20:43Z

Greptile Summary

Improves README documentation with clearer capability descriptions and concrete installation examples. Replaces vague placeholders with specific hardware platform examples.

Key improvements:

Navigation description updated to "SLAM, path planning, and obstacle avoidance — with or without ROS"
Perception description expanded to "Object detection, depth estimation, VLM reasoning, and audio — from camera to understanding"
Removed dead video link (#) from Perception section
Added concrete install examples with --replay and --simulation flags
Added development section simulation example

Issues found:

Package extras unitree-go2 and unitree-g1 don't exist in pyproject.toml - only unitree is valid
All three install commands use invalid package extras that will cause installation to fail

Confidence Score: 2/5

This PR contains critical syntax errors that will break installation for users
While the documentation improvements are good, the install commands use non-existent package extras (unitree-go2, unitree-g1) that will cause pip installation to fail. These need to be changed to the valid unitree extra before merging
README.md requires fixes to all three package installation commands (lines 147, 158, 164)

Important Files Changed

Filename	Overview
README.md	Documentation improvements with clearer descriptions and concrete examples, but package extras `unitree-go2` and `unitree-g1` don't exist in pyproject.toml

_{Last reviewed commit: 69e8f42}

greptile-apps

_{1 file reviewed, 3 comments}

_{Edit Code Review Agent Settings | Greptile}

greptile-apps · 2026-02-19T12:20:47Z

README.md

-uv pip install dimos[your_hardware_platform]
-dimos run your_platform_blueprint
+# Install with Unitree Go2 support
+uv pip install dimos[unitree-go2]


unitree-go2 is not a valid package extra in pyproject.toml. The valid extra is unitree. Should be dimos[unitree]

Suggested change

uv pip install dimos[unitree-go2]

uv pip install dimos[unitree]

greptile-apps · 2026-02-19T12:20:48Z

README.md

+
+```bash
+# Install with simulation support
+uv pip install dimos[unitree-go2,sim]


unitree-go2 is not a valid package extra. Should be unitree

Suggested change

uv pip install dimos[unitree-go2,sim]

uv pip install dimos[unitree,sim]

greptile-apps · 2026-02-19T12:20:49Z

README.md

+dimos --simulation run unitree-go2
+
+# Run G1 humanoid in simulation
+uv pip install dimos[unitree-g1,sim]


unitree-g1 is not a valid package extra in pyproject.toml. Should be unitree

Suggested change

uv pip install dimos[unitree-g1,sim]

uv pip install dimos[unitree,sim]

…dead perception link

* move, no fixed links * fix renamed references * add missing assets * fix doclink tests * Update docs/usage/README.md * - * testing inline ascii art * adjusting ascii * ascii adjust * micro adjustments * readme * readme * svg logo tests * light/dark svg * alignment * alignment attemps * testing raw ascii * trying to fix rendering * fixing centering * shifting * cleanup * .. * testing table * size * new table row * added agents * watch video links * hr * table ased lines * .. * checking if diff branch triggers CI * code cleanup run only on PR * better detections image * renamed to rerender * .. * .. * maybe svg is better * I'm sorry to say svg is better * .. * .. * .. * .. * .. * .. * .. * nav gif * better nav gif * .. * correct table * hardware links * .. * .. * go2 link test * .. * hw links * .. * structure * .. * .. * install * .. * .. * upload gif * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * torque * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * .. * docs: add Go2 non-ROS navigation docs, update README, pull agent docs - Add Go2 native navigation documentation with pipeline step images - Update README with shields badges, hardware table, nav links - Pull docs/agents and dimos/utils/docs from main - Add hardware integration guide placeholder - Rename sensor_streams to data_streams * ... * fix graph * native nav docs wrap * nav wrap * docs: fix pikchr diagram - labels above/below, dashed Twist arrow * diagram fixed * .. * .. * .. * .. * docs: link CostMapper heading to source file in nav docs * .. * .. * .. * .. * agents doc * API renamed to usage * docs: fix README API section links to correct docs/usage/ paths (#1297) All documentation lives under docs/usage/, not docs/api/. Fixed: - Modules, LCM, Blueprints, Configuration, Visualization links - Transports link (now points to docs/usage/transports/index.md) - Data Streams links (both in feature grid and API section) - ROS interop section transport link * Update docs/installation/nix.md * Fix virtual environment activation path in nix.md * docs: fix all broken links in README (#1298) - #hardware anchor → #platforms (matches actual heading) * docs(readme): link drone and mavlink entries to dimos/robot/drone (#1299) * per os install instructions * Update video links and text in README * main readme install update * typos/small fixes for install * typos, small fixes for main readme * Update installation instructions and remove guide link Removed outdated hardware integration guide link and updated Ubuntu version in installation instructions. * Added new gifs, spatial memory * updated gifs * docs(readme): nav description, quickstart with real examples, remove dead perception link (#1301) * docs(readme): nav description, quickstart with real examples, remove dead perception link * fix: revert perception description, only remove dead video link * Revise Python installation and development instructions Updated installation instructions and quickstart section for clarity and added emphasis on development. * readme changes * Revise README title and introduction for clarity Updated the title and description to reflect the agentive nature of the operating system. * Readme updates * Update README.md * Readme updates * Readme updates * CI code cleanup * docs(readme): add Unitree B1 to quadruped hardware table (#1302) * docs(transports): fix broken image paths — assets/ → ../assets/ (#1303) --------- Co-authored-by: Jeff Hykin <jeff.hykin@gmail.com> Co-authored-by: s <pomichterstash@gmail.com> Co-authored-by: spomichter <12108168+spomichter@users.noreply.github.com>

greptile-apps bot reviewed Feb 19, 2026

View reviewed changes

docs(readme): nav description, quickstart with real examples, remove …

cc979b8

…dead perception link

spomichter force-pushed the docs/add-drone-readme-links branch from 69e8f42 to cc979b8 Compare February 19, 2026 12:50

spomichter changed the title ~~docs(readme): real descriptions + working install examples with --simulation~~ docs(readme): nav description, quickstart with real examples, remove dead perception link Feb 19, 2026

fix: revert perception description, only remove dead video link

c3196d9

spomichter merged commit b05f714 into ivan/maindocs2 Feb 19, 2026
15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(readme): nav description, quickstart with real examples, remove dead perception link#1301

docs(readme): nav description, quickstart with real examples, remove dead perception link#1301
spomichter merged 2 commits intoivan/maindocs2from
docs/add-drone-readme-links

spomichter commented Feb 19, 2026 •

edited

Loading

Uh oh!

greptile-apps bot commented Feb 19, 2026

Uh oh!

greptile-apps bot left a comment

Uh oh!

greptile-apps bot Feb 19, 2026

Uh oh!

greptile-apps bot Feb 19, 2026

Uh oh!

greptile-apps bot Feb 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Comments

	uv pip install dimos[unitree-go2]
	uv pip install dimos[unitree]

	uv pip install dimos[unitree-go2,sim]
	uv pip install dimos[unitree,sim]

	uv pip install dimos[unitree-g1,sim]
	uv pip install dimos[unitree,sim]

Conversation

spomichter commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

greptile-apps bot commented Feb 19, 2026

Greptile Summary

Confidence Score: 2/5

Important Files Changed

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Comments

spomichter commented Feb 19, 2026 •

edited

Loading