Skip to content

Docs: clarify Windows setup for documentation site #4350

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
liamfallon merged 1 commit into from
Jan 28, 2026
Merged

Docs: clarify Windows setup for documentation site #4350

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion documentation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,14 @@ npm install
Then run the site using `npm run serve`. To have the site run locally with a functioning local search, run
`npm run serve:with-pagefind`.

### Windows note (PowerShell/CMD)

The site pulls some dependencies via Git submodules. If `npm install` succeeds but the site fails to build (for example, missing theme assets), initialize submodules and try again:

```powershell
git submodule update --init --recursive
```

## License

Licensed under the [Creative Commons Attribution 4.0 International license](LICENSE-documentation)