Skip to content

docs: Windows quick-start and a platform-aware doctor preflight#215

Open
luminary19 wants to merge 3 commits into
sybil-solutions:mainfrom
luminary19:up/doctor-docs
Open

docs: Windows quick-start and a platform-aware doctor preflight#215
luminary19 wants to merge 3 commits into
sybil-solutions:mainfrom
luminary19:up/doctor-docs

Conversation

@luminary19

Copy link
Copy Markdown
Contributor

Summary

Makes the doctor preflight platform-aware and adds a Windows quick-start to
the README.

scripts/doctor.sh:

  • Python check tries python3, then python, then the py launcher (each
    verified to actually run), instead of python3 only.
  • Detects Windows via uname -s (MINGW*/MSYS*/CYGWIN*) and, on Windows,
    prints the accurate GPU line — "CUDA llama.cpp serving available (vLLM/SGLang
    require Linux)" — and defaults the models dir to %USERPROFILE%\models
    instead of /models. The POSIX branch is byte-for-byte the previous behavior.

README.md:

  • Notes Apple Silicon → MLX and Windows → llama.cpp/CUDA in the prereqs, and the
    %USERPROFILE%\models default.
  • Adds a Windows subsection: Git-for-Windows/Bun/Node/Python prereqs, the
    PowerShell 5.1 && caveat, the services/node_modules junction (no Developer
    Mode needed), the llama.cpp prebuilt-CUDA install location, the vLLM/SGLang
    Linux-only note, and the LOCAL_STUDIO_CHROME_PATH browser override.

Docs-and-preflight only; no runtime code changes. The Windows llama.cpp install
and browser behavior it documents ship in the wave-3 PRs (llamacpp-install,
browser-host).

Validation

bash -n scripts/doctor.sh clean. Ran npm run doctor live on Windows 11
(Git Bash): all three new Windows branches fire correctly —
PASS python3 3.11.9 found, INFO nvidia-smi found — CUDA llama.cpp serving available (vLLM/SGLang require Linux), PASS models dir C:\Users\…\models exists and is writable — 7 pass / 0 fail. On Linux the script takes the unchanged
POSIX branch.

UI changes

None.

Risks / rollout notes

  • Pure docs + shell-preflight change; no effect on the controller, frontend, or
    CI beyond the doctor script's own output.

Fixes #214.

@luminary19
luminary19 requested a review from 0xSero as a code owner July 13, 2026 19:47
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.

[BUG] doctor preflight is POSIX-only (python3//models/GPU) and the README has no Windows quick-start

1 participant