Skip to content

Title: docs: Highlight WSL requirement for Windows users in node setup guide #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MAYANK-MAHAUR
Copy link
Contributor

Description:

  • Improves visibility of the Windows Subsystem for Linux (WSL) requirement in the
    node setup guide.

Changes

  1. Added a dedicated section: "For Windows Users: Important Note on WSL" below the prerequisites.
  • Clearly states the need for WSL and links to the official installation guide.

This helps Windows users avoid confusion by making the WSL requirement more noticeable.

Before-

image

After -

image

the text i added is -
For Windows Users: Important Note on WSL (Windows Subsystem for Linux)
If you are using a Windows system, you must have Windows Subsystem for Linux (WSL) installed and configured with an Ubuntu distribution. The installation commands for the Gaia node are Linux-based and require a Linux environment to run, which WSL provides on Windows.

Copy link
Contributor

juntao commented Jul 12, 2025

Hello, I am a PR summary agent on flows.network. Here are my reviews of code commits in this PR.


Commit 2502961c8590eba301c967f3d77c407d2b9a008a

Key Changes:

  1. WSL Requirement Highlighted: Added a section specifically for Windows users, emphasizing the necessity of having WSL with an Ubuntu distribution to run Linux-based installation commands.
  2. Informative Note: Included a direct link to Microsoft's documentation on installing WSL and detailed instructions for configuration.
  3. Formatting Enhancements: Improved readability by adding bold text to important information, ensuring it stands out to users who may overlook the previous note.
  4. Minor Edit in Existing Text: Removed the original note about needing Ubuntu installed on Windows systems, replacing it with the more detailed WSL instructions.

Overall, the patch enhances clarity for Windows users regarding the need for a Linux environment via WSL.

@MAYANK-MAHAUR
Copy link
Contributor Author

actually when i was installing gaia node for first time i lowkey entered all the cmds in terminal lol it threw errors so i thought it will be a good idea.

here is the video showing changes made -**

20250712-0830-52.4380378.mp4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants