Skip to content

docs: clarify uv add requires an existing uv project#1152

Open
SAY-5 wants to merge 1 commit into
generative-computing:mainfrom
SAY-5:docs/clarify-uv-add-install
Open

docs: clarify uv add requires an existing uv project#1152
SAY-5 wants to merge 1 commit into
generative-computing:mainfrom
SAY-5:docs/clarify-uv-add-install

Conversation

@SAY-5
Copy link
Copy Markdown
Contributor

@SAY-5 SAY-5 commented May 24, 2026

Pull Request

Issue

Fixes #757

Description

The installation docs show uv add mellea, but uv add only works inside an existing uv project (one created with uv init or already holding a pyproject.toml). Users who just want to try Mellea in a plain virtual environment hit an error. This adds a short note clarifying that requirement and pointing to uv pip install mellea as the no-project alternative, matching the maintainer suggestion in the issue thread.

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code was added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

Attribution

  • AI coding assistants used

Adding a new component, requirement, sampling strategy, or tool?

If your PR adds or modifies one of the types below, check the matching box. A checklist of type-specific review items will be posted as a comment.

  • Component
  • Requirement
  • Sampling Strategy
  • Tool

NOTE: Please ensure you have an issue that has been acknowledged by a core contributor and routed you to open a pull request against this repository. Otherwise, please open an issue before continuing with this pull request.

Signed-off-by: SAY-5 <say.apm35@gmail.com>
@SAY-5 SAY-5 requested a review from a team as a code owner May 24, 2026 20:38
@SAY-5 SAY-5 requested review from AngeloDanducci and nrfulton May 24, 2026 20:38
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 24, 2026
Copy link
Copy Markdown
Contributor

@planetf1 planetf1 left a comment

Choose a reason for hiding this comment

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

The fix is correct and this is mergeable as a narrowband patch for the immediate confusion.

One note: this leaves the page with three code blocks plus a prose note, which is slightly awkward. The fuller fix — replacing the parallel blocks with headed sections that make the uv project vs venv decision explicit — is tracked in #757 with concrete implementation notes. Up to you whether to extend this PR or merge as-is and let someone pick up #757 separately.

Copy link
Copy Markdown
Collaborator

@serjikibm serjikibm left a comment

Choose a reason for hiding this comment

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

Looks like a good narrow fix to the docs just to avoid confusion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Install steps in docs

3 participants