[#1006] docs(install-windows): Bring the WSL2 guide to current setup parity#1014
Merged
Conversation
…parity Make docs/install-windows.md independently usable instead of deferring to the Mac guide, and align every command with the current code / the corrected install-mac.md (#1005). - Inline the full flow inside WSL2: install agent CLIs (Claude Code / Codex / Gemini CLI), authenticate, install QuadWork (verify via `npm list -g quadwork`, example 2.7.0), `quadwork init` / `start` / `stop`. - Cover first-run per-role backend + model selection (Agent Models step), worktree creation (project-head/dev/re1/re2), auto-answered Claude trust prompt, dashboard at http://127.0.0.1:8400, and clean shutdown via ~/.quadwork/server.pid. - Add a self-contained optional Discord/Telegram bridge note. - Keep only accurate WSL-specific limitations (caffeinate n/a, paths, VS Code WSL extension, shared localhost); Node aligned to 20+ (24 recommended). - Remove all "identical to the Mac guide / follow the Mac guide" pointers. Docs-only; no runtime code, tests, package versions, legacy migration implementation, or other documents touched. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
project7-interns
approved these changes
Jul 17, 2026
project7-interns
left a comment
Collaborator
There was a problem hiding this comment.
Verdict: APPROVE
Epic Alignment: PASS
The one-file WSL2 guide fulfills #1006’s independent setup-flow contract and preserves #1007’s VPS boundary.
Checked (evidence)
- Scope and independence: live
gh pr diff 1014→docs/install-windows.mdonly; noinstall-macor Mac-guide deferral remains. - Lifecycle claims: current head
server/index.js:2324binds the dashboard to loopback;bin/quadwork.js:928,947auto-opens it and recordsserver.pid. - Worktree/WSL limitation claims:
bin/quadwork.js:630-631names the four worktrees;server/index.js:301-316makes caffeinate macOS-only. - Riskiest part of this diff: Windows/WSL guidance; CLI install, interactive auth, model selection, bridge widgets, and stop/restart steps are fully inlined and consistent with current sources.
- Kill-list: scanned all new diff ranges — clean.
- CI:
gh pr checks 1014→test pass(51s).
Findings
- None.
Decision
The guide is independently usable, keeps only accurate WSL-specific constraints, and satisfies every #1006 acceptance criterion with a passing live check.
Owner
Author
@re2 Independent Review — APPROVE ✅ (head
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1006
Summary
Docs-only. Rewrites
docs/install-windows.mdto be independently usable — it no longer defers to the Mac guide ("identical to the Mac guide" / "Follow the Mac Guide"). Every command is inlined and verified against the current code and the correctedinstall-mac.md(#1005). Scope:docs/install-windows.mdonly.Changes
@anthropic-ai/claude-code,@openai/codex,@google/gemini-cli) + interactive auth; Step 5 installs QuadWork and verifies withnpm list -g quadwork(example2.7.0); Step 6 runsquadwork init/start, withquadwork stopin the shutdown section.opus/sonnet,gpt-5.4/gpt-5.6-*,gemini-2.5-pro/-flash, or(CLI default)).project-head/dev/re1/re2created next to the repo, seeded withAGENTS.md+CLAUDE.md; Claude trust prompt auto-answered at agent startup (no manual pre-trust).http://127.0.0.1:8400(loopback, shared with Windows by WSL2); clean shutdown via~/.quadwork/server.pid; pm2 background note.~/.quadwork/config.json).caffeinaten/a,/home/<user>/paths, VS Code WSL extension, shared localhost. Node aligned to 20+ (24 recommended).EPIC Alignment
docs/install-windows.md. This diff touches exactly that file.rg -i "identical|follow the mac|install-mac" docs/install-windows.md→ no matches.Self-Verification
@anthropic-ai/claude-code,@openai/codex,@google/gemini-cli(matchdocs/install-mac.md:61,64,67).npm install -g quadwork@latest; verifynpm list -g quadwork→quadwork@2.7.0(package.jsonversion 2.7.0).quadwork --versionis intentionally not used (not a subcommand —bin/quadwork.jsdispatch has no version case).init/start/stop:bin/quadwork.js:1352-1361.server/index.js:2324(server.listen(PORT, "127.0.0.1", …));bin/quadwork.js:928. Default port 8400:bin/quadwork.js:253,864,911.~/.quadwork/server.pid:bin/quadwork.js:947.caffeinateis macOS-only (server/index.js:311) → correctly "not applicable" on WSL2.src/components/SetupWizard.tsx:188-192,src/lib/agentModels.ts:10-45.project-head/dev/re1/re2:bin/quadwork.js:630-631. Trust auto-answer:server/index.js:1182.rg -n -i "identical|follow the mac|install-mac|from the mac guide" docs/install-windows.md→ no matches.git diff --stat→docs/install-windows.mdonly.Acceptance criteria
docs/install-windows.md