Docs: Install & Develop

[jeff-hykin]

• Test by just looking at the readme and linked fles
• Note: github badges are broken because the repo isn't public
• Note: there's more comprehsive docs changes on jeff_day1_docs_full, but its better to get this small one merged first
• Note: New Gif Recordings and Screenshots coming in separate PR

All shell and python code should be fully working

[greptile-apps]

Greptile Summary

This PR significantly redesigns the documentation by creating new development and concepts guides while simplifying the main README. The changes include a substantial rewrite of the README from 490 lines to 185 lines, focusing on extremely minimal installation and basic usage examples, plus new comprehensive docs for blueprints and development setup.

Key Changes:

• README.md: Streamlined to essentials—removed lengthy feature descriptions, consolidated installation instructions, and added quick-start options
• docs/concepts/blueprints.md: New file documenting the blueprints architecture with detailed code examples
• docs/development/README.md: New comprehensive development guide with three setup options (System Install, Nix Flake + direnv, Pure Nix Flake) and PR contribution guidelines

Issues Found:

• Spelling error in blueprints.md: "acomplished" should be "accomplished"
• Typo in development README: "youraq" should be "your"
• Broken reference to non-existent file: /docs/development/large_file_management.md
• Unclear branch choice: Development guide clones from main instead of potentially dev

Confidence Score: 2/5

• PR introduces documentation with multiple issues that need resolution before merging
• The PR successfully restructures documentation to be more user-friendly, but contains three actionable issues: two spelling/syntax errors and one broken documentation link. The branch confusion in setup instructions also needs clarification. These are straightforward to fix but should be addressed before merge.
• docs/development/README.md (missing file reference, typo, branch confusion), docs/concepts/blueprints.md (spelling error)

Important Files Changed

Filename	Overview
README.md	Major restructure of README with simplified installation and usage examples. Significantly reduced from 490 to 185 lines, focusing on minimal install and basic examples. All links are valid and references to documentation files are correct.
docs/concepts/blueprints.md	New documentation file explaining blueprints architecture with code examples. Contains one spelling error ("acomplished" instead of "accomplished") on line 13.
docs/development/README.md	New comprehensive development guide with setup options and PR guidelines. Contains typo on line 272 ("youraq"), references non-existent file on line 275, and clones from main branch instead of potentially dev branch for development.

[greptile-apps]

_{3 files reviewed, 4 comments}

_{Edit Code Review Agent Settings | Greptile}

[paul-nechifor]

Wouldn't this be preferred:

uv init
uv add 'dimos[base,unitree]'
uv run dimos --replay run unitree-go2

uv pip is a compatibility layer with pip, it's not the optimal way to use uv.

Also, I would explicitly state what the purpose of running dimos --replay run unitree-go2 is. Something like "# Replay recorded data to check that the system is working."

[jeff-hykin]

I debated whether to do the uv init, uv sync route. If people want to add dimos to an existing non-uv python project, I think it will be more clear to them how to adapt the . .venv/bin/activate and uv pip install -e to their project compared to knowing how to adapt uv init and uv add.

So far everyone (Pim, Clair, Yas) has been confused by uvx --from so I imagine its similar for uv add.

I also think we should go for a venv where they can run dimos directly instead of uv run dimos run (feels really verbose).

I don't have strong feelings about this, so I'll defer to what existing members prefer.

I would explicitly state what the purpose of running dimos --replay run unitree-go2

Sounds good

[paul-nechifor]

This is a broken link.