Skip to content

Suggestion to Improve Oppia Documentation (Setup Environment - Point 8) #465

@VanshikaSabharwal

Description

@VanshikaSabharwal

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:
Image

Metadata

Metadata

Labels

Type

No type

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions