Skip to content

Update docs to --all-groups#2065

Open
Dreamsorcerer wants to merge 1 commit into
mainfrom
all-groups
Open

Update docs to --all-groups#2065
Dreamsorcerer wants to merge 1 commit into
mainfrom
all-groups

Conversation

@Dreamsorcerer
Copy link
Copy Markdown
Collaborator

Having moved development dependencies from the extras into groups, developers will now need to install the groups.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 12, 2026

Greptile Summary

This PR updates four documentation files to replace --all-extras with --all-groups following a migration of development dependencies (tests, lint, mypy) from optional extras into dependency groups. The install guides for macOS and Ubuntu now include an explicit uv sync --all-groups step so that mypy and the full test toolchain are available out of the box.

  • docs/installation/osx.md and docs/installation/ubuntu.md: added uv sync --all-groups before the mypy and pytest steps, replacing the old comment that implied uv run alone was sufficient.
  • docs/development/testing.md: swapped --all-extras to --all-groups in the self-hosted sync snippet; the opening sentence still only mentions the tests group and does not mention that --all-groups is now also needed for mypy/lint.
  • README.md: updated the inline comment to reference --all-groups and adds mypy as a reason, consistent with the new guide wording.

Confidence Score: 4/5

Documentation-only change that correctly reflects the move from extras to groups; safe to merge.

The install guides and README are updated consistently. The one gap is that docs/development/testing.md's opening sentence still describes only the tests group being synced by uv run, without mentioning that --all-groups is now needed for mypy/lint — a developer relying solely on that file could miss the required sync step.

docs/development/testing.md — opening paragraph does not mention the new --all-groups requirement for mypy/lint.

Important Files Changed

Filename Overview
README.md Updated comment from --all-extras to --all-groups, adding mypy as a reason; no explicit uv sync --all-groups command shown, unlike the install guides
docs/development/testing.md Swapped --all-extras to --all-groups with an updated comment; change is accurate and consistent with the self-hosted sync instructions
docs/installation/osx.md Added explicit uv sync --all-groups step before mypy and pytest in the dev setup block; correctly ensures lint and test tools are available
docs/installation/ubuntu.md Same change as osx.md — explicit uv sync --all-groups added before mypy/pytest; mirrors the macOS guide correctly

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Clone repo] --> B[uv sync --all-groups]
    B --> C{What do you need?}
    C -->|Type check| D[uv run mypy dimos]
    C -->|Default tests| E[uv run pytest --numprocesses=auto dimos]
    C -->|Self-hosted tests| F[uv sync --group tests-self-hosted]
    F --> G[uv run pytest -m self_hosted dimos]
    D --> H[Done]
    E --> H
    G --> H
Loading

Comments Outside Diff (1)

  1. docs/development/testing.md, line 3 (link)

    P2 The opening sentence still says uv run syncs only the tests group and that "no upfront install" is needed, but this PR's broader context is that mypy/lint tools have moved into groups that uv run won't sync by default. A developer reading only this file will miss that uv sync --all-groups is now required for type-checking, not just for self-hosted tests.

Reviews (1): Last reviewed commit: "Update docs to --all-groups" | Re-trigger Greptile

@paul-nechifor paul-nechifor enabled auto-merge (squash) May 13, 2026 01:33
@leshy
Copy link
Copy Markdown
Contributor

leshy commented May 13, 2026

some issue with CI with this @Dreamsorcerer

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.

3 participants