Conversation
- Document both pip and uv installation methods with clear guidance - Update README to show pip as recommended for CI/production - Update uv as faster option for local development - Align command examples to use standard python invocation - Fix step numbering in configuration section - Update requirements section to mention both tools Closes #302 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
😎 Merged manually by @abhimehro - details. |
…docs-c34ae159b827b41a
github-actions
bot
added
the
documentation
Author
|
👋 Development Partner is reviewing this PR. Will provide feedback shortly. |
There was a problem hiding this comment.
Pull request overview
This PR addresses issue #302 by standardizing the dependency installation documentation to clearly explain both pip and uv installation methods, eliminating confusion about which tool to use and when. The changes align the README documentation with the actual CI implementation used in sync.yml while preserving the flexibility to use either dependency manager.
Changes:
- Restructured installation section to document both pip (for CI/production) and uv (for faster local development) methods
- Updated command examples from
uv run python main.pytopython main.pyto match CI workflow usage - Fixed step numbering sequence (previously had duplicate step 2 and 3)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Author
|
👋 Development Partner is reviewing this PR. Will provide feedback shortly. |
1 similar comment
Author
|
👋 Development Partner is reviewing this PR. Will provide feedback shortly. |
abhimehro
deleted the
daily-backlog-burner/standardize-dependency-docs-c34ae159b827b41a
branch
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.
Goal and Rationale
This PR addresses issue #302 by standardizing the dependency installation documentation to clarify the relationship between pip and uv, eliminating confusion for new contributors and users.
Problem: README recommended
uv syncwhile CI workflows usedpip install -r requirements.txt, creating ambiguity about the correct installation method.Why this matters: Clear onboarding documentation reduces friction for new contributors and ensures consistency between local development and CI environments.
Approach
Following the issue's recommended Option 3: Document both methods clearly with guidance on when to use each.
Implementation steps:
python main.pysyntax (removinguv run)Impact
What changed:
What was fixed:
Validation
Testing approach:
Success criteria met:
✅ Both installation methods documented clearly
✅ No confusion about which tool to use
✅ Alignment between README and CI usage
✅ Command examples work with standard Python installation
Future Work
Related opportunities identified:
.venvto.gitignoreif not already presentCloses #302