docs: clarify uv add requires an existing uv project#1152
Open
SAY-5 wants to merge 1 commit into
Open
Conversation
Signed-off-by: SAY-5 <say.apm35@gmail.com>
planetf1
reviewed
May 26, 2026
Contributor
planetf1
left a comment
There was a problem hiding this comment.
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.
serjikibm
approved these changes
May 26, 2026
Collaborator
serjikibm
left a comment
There was a problem hiding this comment.
Looks like a good narrow fix to the docs just to avoid confusion.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
Issue
Fixes #757
Description
The installation docs show
uv add mellea, butuv addonly works inside an existing uv project (one created withuv initor already holding apyproject.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 touv pip install melleaas the no-project alternative, matching the maintainer suggestion in the issue thread.Testing
Attribution
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.
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.