Enhanced Installation Section in README.md #35094
Conversation
Enhanced installation section with troubleshooting, GPU setup, and OS-specific details.
Enhanced installation section with troubleshooting, GPU setup, and OS-specific details.
|
cc @stevhliu! |
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
|
Hi @Rocketknight1 and @stevhliu, I noticed that this pull request requires workflow approval and a review to proceed. All checks have passed so far and I have updated the branch to sync with main. Could you kindly review and approve the workflows when convenient? Let me know if further changes are required. Thanks!" |
|
We want the README.md to stay quite minimal, but those changes could be applied in the installation section in the docs! |
Updated installation.md to include virtual environment and GPU setup instructions.
Updated installation.md to include virtual environment and GPU setup instructions.
Updated installation.md to include virtual environment, troubleshooting and GPU setup instructions.
Updated installation.md to include virtual environment, troubleshooting functions and GPU setup instructions.
Updated installation.md to include virtual environment, troubleshooting functions and GPU setup instructions.
Updated installation.md to include virtual environment, troubleshooting functions and GPU setup instructions.
|
Hi @LysandreJik, @Rocketknight1, @stevhliu and team, Thank you for the earlier feedback. Based on your suggestion, I have migrated the detailed installation instructions from the README.md file to the installation.md section under docs/en. **Summary of Changes: ** Steps for creating and activating virtual environments across macOS, Linux and Windows, with additional guidance for potential Windows-specific issues. **GPU Setup Section: ** **Troubleshooting Guide: ** Best regards, |
docs/source/en/installation.md
Outdated
| ### Create and Activate a Virtual Environment | ||
|
|
||
| Activate the virtual environment. On Linux and MacOs: | ||
| To avoid dependency conflicts, it’s recommended to use a virtual environment. | ||
|
|
||
| ```bash | ||
| source .env/bin/activate | ||
| #### For macOS/Linux: | ||
| ``` | ||
| Activate Virtual environment on Windows | ||
|
|
||
| ```bash | ||
| .env/Scripts/activate | ||
| python3 -m venv env | ||
| source env/bin/activate | ||
| ``` | ||
| #### For window OS: | ||
| ``` | ||
| python -m venv env | ||
| .\env\Scripts\activate |
There was a problem hiding this comment.
I don't think this section really adds anything new, so I think it can also be removed
There was a problem hiding this comment.
Hi @stevhliu,
I have removed the "Create and Activate a Virtual Environment" section as suggested. I understand the concern about redundancy. Would it be helpful to refine this section to emphasize the benefits of virtual environments and include troubleshooting tips? Let me know your thoughts.
Removed numbering from README.md.
Removed unnecessary "a)" formatting as per maintainer feedback.
Added blank lines around code snippets for better readability.
Removed the line "b) Install a backend framework:" from README.md as per feedback.
Simplified "For Windows:" to "Windows" in README.md as per feedback as well as "For macOS/Linux:" to "macOS/Linux"
Removed unnecessary heading and retained valid code snippet.
Removed unnecessary heading "d) Optional: Install from source for the latest updates" as per feedback.
Removed "GPU Setup (Optional)" section to align with minimal design feedback.
Removed "Create and Activate a Virtual Environment" section from installation.md as per feedback.
Adjusted "Troubleshooting" to a second-level heading and added an introductory line as per feedback.
Updated troubleshooting section with simplified headings and formatted code blocks as per feedback.
Integrated GPU setup instructions into the "Install with pip" section for better content flow.
|
Hi @stevhliu, |
Removed Troubleshooting section from README.md for minimalism as per maintainer feedback.
This PR improves the Installation section in the README.md file by:
These enhancements aim to improve the clarity and usability of the installation instructions for new users.