Skip to content

docs: compact system requirements into table, move details to docs/#1402

Open
spomichter wants to merge 2 commits intodevfrom
docs/compact-system-requirements
Open

docs: compact system requirements into table, move details to docs/#1402
spomichter wants to merge 2 commits intodevfrom
docs/compact-system-requirements

Conversation

@spomichter
Copy link
Contributor

Problem

The System Requirements section in README is a wall of text with separate headings for GPU, CPU, Memory, and Storage. It clutters the main README with details most people don't need upfront.

Solution

  • README: replaced the verbose section with a compact summary table (Component / Minimum / Recommended)
  • docs/requirements.md: moved full details here — expanded specs, tested configurations table, headless server notes, OS support

The README now links to the full doc for anyone who needs the details.

Breaking Changes

None — documentation only.

How to Test

git fetch origin && git checkout docs/compact-system-requirements
# View the README on GitHub to verify table renders correctly
# Check docs/requirements.md exists with full details

Contributor License Agreement

  • I have read and approved the CLA

Copy link
Contributor

@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.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.


## Operating System

- **Ubuntu 22.04 / 24.04** (primary supported platform)
Copy link
Collaborator

@Dreamsorcerer Dreamsorcerer Mar 4, 2026

Choose a reason for hiding this comment

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

Should we make this a minimum to reduce likelihood of this getting outdated?

Suggested change
- **Ubuntu 22.04 / 24.04** (primary supported platform)
- **Ubuntu 22.04 or later** (primary supported platform)

spomichter added a commit that referenced this pull request Mar 11, 2026
…e stale development README (#1524)

* docs(cli): add full CLI reference, delete stale dev README

- New docs/usage/cli.md: all commands, global options, standalone tools,
  MCP integration, config precedence, file locations
- Delete docs/development/README.md: duplicated main README content
- Delete docs/development/dimos_run.md: superseded by cli.md

* docs: add system requirements and dependency tier matrix

- README: compact hardware table, link to full details
- docs/requirements.md: tested configs, all dependency extras,
  core vs docker tier, platform compatibility notes
- Subsumes PR #1402 content with expanded dependency coverage

* docs: delete empty todo.md

* docs: distinguish Jetson AGX Orin (tested) vs Orin Nano (experimental)

* docs: remove core deps and docker extra sections from requirements

* docs: add missing psql and dds extras to dependency tiers

* docs: README overhaul — beta, CLI/MCP section, zsh quotes, hardware tiers

- Alpha Pre-Release → Pre-Release Beta
- Arms (Xarm, Piper): experimental → beta
- Drones (MAVLink, DJI): experimental → alpha
- Delete System Requirements section (moved to docs/requirements.md)
- Delete ROS interop section (transports link in Library API)
- Add CLI & MCP overview with common commands
- Add blueprint composition examples with dimos list
- Quote all pip install extras for zsh compatibility
- Fix todo.md links → manipulation docs for arms

* docs: revert blueprint section to original

* docs: update title, trim CLI section, add coding agents blurb

* docs: remove headless section from main README (covered in docs/requirements.md)

* docs: add featured blueprints section, move coding agent note above installation

* docs: featured runfiles with run commands, highlight agent note, move requirements link

* docs: move → relative_move per Paul's review, add zsh quotes to requirements.md

* docs: use GitHub [!TIP] callout for agent note

* docs: show TIP/NOTE/IMPORTANT variants for comparison

* docs: use [!IMPORTANT] callout with updated agent wording

* docs: install script URL dev → main

* docs: move featured runfiles above CLI, 2.4GB → 75MB replay size

* docs: trim featured runfiles to 5 key examples

* docs: add replay-dir, simulation flags to featured runfiles

* docs: add keyboard-teleop-xarm7 to featured runfiles

* docs: add ollama blueprint to featured runfiles

* docs: write agents readme, delete empty integration guide

* docs: DJI SDK → DJI Mavic in hardware table

* update agent docs

* docs: navigation links to native/index.md, unlink perception stub

---------

Co-authored-by: Paul Nechifor <paul@nechifor.net>
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.

2 participants