Clarify virtual environment setup instructions (Points 7 & 8)#513
Open
VanshikaSabharwal wants to merge 3 commits intooppia:developfrom
Open
Clarify virtual environment setup instructions (Points 7 & 8)#513VanshikaSabharwal wants to merge 3 commits intooppia:developfrom
VanshikaSabharwal wants to merge 3 commits intooppia:developfrom
Conversation
Author
Member
|
@jayam04 PTAL, thanks! |
jayam04
requested changes
Feb 27, 2026
Member
jayam04
left a comment
jayam04
left a comment
There was a problem hiding this comment.
@VanshikaSabharwal Left a review.
|
|
||
| 8. Create a virtual environment for oppia by adding file named `.envrc` into the parent folder of the oppia repository | ||
| with this content: | ||
| 8. Create a virtual environment for oppia by adding file named `.envrc` into the root folder containing the oppia repository with this content: |
Member
There was a problem hiding this comment.
Can we make this oppiaroot folder.
jayam04
reviewed
Mar 5, 2026
Member
jayam04
left a comment
jayam04
left a comment
There was a problem hiding this comment.
@VanshikaSabharwal Thanks for updating the doc. I left a review
| > Be careful with using graphical editors like Notepad in Windows. These can add carriage returns (`\r`) that confuse our Linux-based development tools. Instead, we recommend using editors designed for programming or command-line text editors. | ||
|
|
||
| 8. Create a virtual environment for oppia by adding file named `.envrc` into the parent folder of the oppia repository | ||
| with this content: |
Member
There was a problem hiding this comment.
Can you also specific path ../ or something similar.
Author
There was a problem hiding this comment.
I think there is no as such path for this. Can you please specify a path if you have in mind?
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
3 participants
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.
PR Description
Background:
In the Oppia installation docs, the instructions for setting up the virtual environment (points 7 and 8) caused some confusion for beginners:
Point 7: Mentioned adding the .direnvrc file to the “home directory,” but did not explain how users could verify they were in the correct directory.
Point 8: The wording around creating a virtual environment was a bit technical and could be simplified.
Changes Made:
Point 7:
Clarified that the .direnvrc file should be added to the user’s home directory (e.g., /home/your-username/).
Introduced the commonly used tilde (~) shorthand to refer to the home directory.
Added a suggestion to run pwd to verify the current directory before creating the file.
Point 8:
Reworded instructions to be more beginner-friendly, explaining in simpler language how to create the .envrc file in the root folder of the cloned Oppia repository.
Example of updated text:
“Add a new file called .direnvrc into your user’s home (~) directory (e.g., /home/your-username/). You can run pwd to verify that you are in the correct directory. Then add the following content …”
“Create a virtual environment for Oppia by adding a file named .envrc into the root folder containing the Oppia repository with this content: use python 3.10.16. Then run direnv allow. Now whenever you are within the oppia folder, the virtual environment will be active.”
Impact:
These changes improve clarity and reduce confusion for first-time users setting up Oppia on their local machine.
Related Issue: #465