Skip to content

docs: add note for wsl users about filesystem location. #6101

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.

Sign up for GitHub

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

Merged
ahcorde merged 5 commits into from
Dec 19, 2025
Merged

docs: add note for wsl users about filesystem location. #6101

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c6391d9
docs: add note for wsl user about filesystem location.
bhumilmayani12-oss Dec 18, 2025
a82e75c
Merge branch 'rolling' into fix-doc-build-notes
fujitatomoya Dec 19, 2025
ad746f6
docs: fix typos in WSL filesystem note
bhumilmayani12-oss Dec 19, 2025
070ecdf
Merge branch 'fix-doc-build-notes' of https://github.com/bhumilmayani…
bhumilmayani12-oss Dec 19, 2025
cc063b4
docs: fix spellcheck typos
bhumilmayani12-oss Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,9 @@ To test building the multisite version deployed to the website use:
`sensible-browser build/html/rolling/index.html`

**NB:** This will ignore local workspace changes and build from the branches.

### Note for windows (wsl) Users

When building the documentation on windows using wsl, it is recommened to clone and work with this repository inside the Linux filesystem (for example, under `/home/<user>/`) rather than under `/mnt/c`.

Woking under `/mnt/c` can lead to slower builds and filesystem-related issues with Sphinx and ROS tooling.
Loading