oppia / oppia/oppia-web-developer-docs

[Feature Request]:Improve Windows-specific guidance in installation guide

Open Beginner friendly
#497 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
18
Forks
134
PR merge metrics
No merged PRs in 30d

Description

Improve Windows-specific guidance in installation guide
Yes. The current installation guide is mostly platform-agnostic, which can cause confusion for Windows users. As a first-time contributor using Windows, it was unclear which terminal to use, which Python command (python vs. py) is recommended, and how to avoid common issues like CRLF line endings.

Describe the solution (or solutions) you'd like

Add a short Windows-specific section to the installation guide that:

  • Recommends a preferred terminal (e.g., Git Bash)
  • Clarifies which Python command to use on Windows
  • Mentions common Windows pitfalls such as CRLF line endings
    Suggests suitable editors like VS Code with appropriate settings
Describe alternatives you've considered and rejected

I considered relying on external troubleshooting pages, but having these Windows-specific notes directly in the installation guide would be more helpful for first-time contributors.

This would make the setup process easier for new Windows contributors.

Additional context

This suggestion is based on my experience installing Oppia as a beginner on Windows.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the installation guide and review its existing platform-agnostic setup instructions. Add a concise Windows-specific section covering the preferred terminal, Python command, CRLF line endings, and editor settings; the guide should clearly address the listed first-time contributor pitfalls.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.