Skip to content

Commit a207029

Browse files
docs(windows): note Git Bash requirement for A2UI builds
1 parent 96fb423 commit a207029

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/help/faq.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -583,6 +583,12 @@ Two common Windows issues:
583583
- Add that directory to your user PATH (no `\bin` suffix needed on Windows; on most systems it is `%AppData%\npm`).
584584
- Close and reopen PowerShell after updating PATH.
585585

586+
**3) `pnpm build` fails around `canvas:a2ui:bundle` / `bash`**
587+
588+
- The from-source build bundles A2UI through a Bash script.
589+
- Install **Git for Windows** so Git Bash is available, then reopen PowerShell and rerun the build.
590+
- If you prefer to avoid native Windows shell differences entirely, use **WSL2** for repo builds.
591+
586592
If you want the smoothest Windows setup, use **WSL2** instead of native Windows.
587593
Docs: [Windows](/platforms/windows).
588594

docs/start/setup.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ Last updated: 2026-01-01
2727
- `pnpm`
2828
- Docker (optional; only for containerized setup/e2e — see [Docker](/install/docker))
2929

30+
Native Windows note:
31+
32+
- The repo build runs `pnpm canvas:a2ui:bundle`, which invokes a Bash script for the A2UI host bundle.
33+
- If you build from native Windows instead of WSL2, install **Git for Windows** so Git Bash is available before running `pnpm build` or `pnpm build:strict-smoke`.
34+
- WSL2 remains the recommended Windows path for the full Gateway/tooling stack.
35+
3036
## Tailoring strategy (so updates don’t hurt)
3137

3238
If you want “100% tailored to me” _and_ easy updates, keep your customization in:

0 commit comments

Comments
 (0)