oppia / oppia/oppia-web-developer-docs
Suggestion to Improve Oppia Documentation (Setup Environment - Point 8)
@VanshikaSabharwal is already working on this.
Since Jun 9, 2025.
- Dominant language
- Python
- Stars
- 18
- Forks
- 134
- PR merge metrics
- No merged PRs in 30d
Description
In the Oppia Installation Docs, point number 8 under "Setup a virtual environment" mentions:
“...create a .direnvrc file in your home directory...”
This usage of the word “home” can be confusing, especially for beginners. It may lead to a misunderstanding between:
- The home directory of the system (i.e. /home/username/)
- The parent folder where Oppia is cloned
Proposed Change
To eliminate this confusion, I suggest updating the wording from:
"...in your home directory..."
to:
"...in the root folder of your computer/laptop (i.e., your home directory, like /home/username/)..."
or more clearly:
"...in your user’s home directory (e.g., /home/your-username/, also called the root folder of your user account)..."
This change ensures clarity for all users, especially those unfamiliar with Linux directory structures.
Here’s a visual illustration for context:
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.