Skip to content

docs: Add quickstart#781

Closed
ym-han wants to merge 1 commit intomultiagent-tutorialfrom
add-quickstart
Closed

docs: Add quickstart#781
ym-han wants to merge 1 commit intomultiagent-tutorialfrom
add-quickstart

Conversation

@ym-han
Copy link
Contributor

@ym-han ym-han commented Nov 29, 2025

I made a separate quickstart doc and linked to it from the README, to make the README less cluttered -- that's how https://github.com/Eventual-Inc/Daft/blob/main/README.rst does it too. But I could also inline it into the README if that's what is preferred.

The quickstart doesn't get you to run a quick Mujoco simulation, but maybe it should. Then again, it's also important for a quickstart to be super concise.

The README needs more cleaning up -- I would personally go for a structure like Daft's -- but that probably shouldn't be part of this PR.

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Nov 29, 2025

Skipped: This PR changes more files than the configured file change limit: (534 files found, 100 file limit)

@chatgpt-codex-connector
Copy link

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

@ym-han ym-han changed the base branch from main to multiagent-tutorial November 29, 2025 18:30
@ym-han ym-han force-pushed the multiagent-tutorial branch from 81601a8 to c7aa30a Compare November 30, 2025 07:06
@ym-han ym-han force-pushed the add-quickstart branch 2 times, most recently from baaf36d to 5d76b4c Compare November 30, 2025 07:55
@ym-han ym-han force-pushed the multiagent-tutorial branch from c7aa30a to 1eb4f6d Compare November 30, 2025 07:55
@ym-han ym-han force-pushed the multiagent-tutorial branch from 1eb4f6d to 8f0129c Compare December 1, 2025 13:06
@ym-han ym-han force-pushed the multiagent-tutorial branch from 8f0129c to 7f5becd Compare December 1, 2025 14:26
@ym-han ym-han force-pushed the multiagent-tutorial branch 2 times, most recently from 263e836 to 5350d2e Compare December 1, 2025 16:17
@ym-han ym-han force-pushed the add-quickstart branch 2 times, most recently from 108084f to b7dcbfa Compare December 2, 2025 03:13
@ym-han ym-han force-pushed the multiagent-tutorial branch 2 times, most recently from dc6cbab to 6d0e96d Compare December 2, 2025 03:42
@ym-han ym-han force-pushed the add-quickstart branch 2 times, most recently from 9f83275 to 46858e5 Compare December 2, 2025 03:52
@ym-han ym-han force-pushed the multiagent-tutorial branch from 6d0e96d to b7f7855 Compare December 2, 2025 03:52
### Install DimOS

```python
pip install -U dimos
Copy link
Contributor

Choose a reason for hiding this comment

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

this wouldnt work im pretty sure since dimos isnt in PyPi public distro yet

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, the install instructions are aspirational / placeholders -- there's a comment to that effect. But maybe I should make it clearer it's TBD

Copy link
Contributor Author

@ym-han ym-han Dec 2, 2025

Choose a reason for hiding this comment

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

I've updated it to make it more explicit that the installation instructions part is just a placeholder. Hopefully after #731 lands and after release, it really will be that easy to install dimos. (Actually after that PR lands, it might be possible to do pip install git+ssh://git@github.com/dimensionalOS/dimos.git even without adding it to PyPi).

(I could link to the current installation instructions, but I really do think the installation needs to be made simpler for non-contributor users. The user-oriented quickstart needs to look quick.)

@ym-han ym-han force-pushed the multiagent-tutorial branch from 1315c1d to 7b78a5a Compare December 3, 2025 18:41
@ym-han ym-han closed this Dec 4, 2025
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