-
Notifications
You must be signed in to change notification settings - Fork 1.9k
docs(readme): update pip install instructions to be relative to root project directory #5212
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(readme): update pip install instructions to be relative to root project directory #5212
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Summary
This PR updates the pip install instructions in the CONTRIBUTING.md documentation to use relative paths from the project root directory. The change modifies four pip install commands (lines 106-109) by removing the onyx/
prefix from the file paths, changing them from onyx/backend/requirements/*.txt
to backend/requirements/*.txt
.
This documentation improvement standardizes the contribution guide to assume developers are working from the root project directory, which aligns with the typical workflow where contributors clone the repository and work from within it. The change makes the documentation more consistent, as other commands throughout the file (like Docker commands and directory navigation instructions) already assume the developer is positioned at the project root. This creates a more coherent and user-friendly setup experience for new contributors.
Confidence score: 5/5
- This PR is safe to merge with minimal risk as it only updates documentation paths
- Score reflects a simple documentation fix with no functional code changes that could cause runtime issues
- No files require special attention as this is purely a documentation update
1 file reviewed, no comments
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No issues found across 1 file
Co-authored-by: Richard Guan <richardguan@Richards-MBP.lan>
Description
It's a bit confusing because these pip install commands need to be run relative to one folder above the root
onyx
folder. I think we should give the commands relative to running them from the mainonyx
folder (so you'd run these right after clone)How Has This Been Tested?
[Describe the tests you ran to verify your changes]
Backporting (check the box to trigger backport action)
Note: You have to check that the action passes, otherwise resolve the conflicts manually and tag the patches.