Skip to content

[#1006] docs(install-windows): Bring the WSL2 guide to current setup parity#1014

Merged
realproject7 merged 1 commit into
mainfrom
task/1006-install-windows-refresh
Jul 17, 2026
Merged

[#1006] docs(install-windows): Bring the WSL2 guide to current setup parity#1014
realproject7 merged 1 commit into
mainfrom
task/1006-install-windows-refresh

Conversation

@realproject7

Copy link
Copy Markdown
Owner

Closes #1006

Summary

Docs-only. Rewrites docs/install-windows.md to 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 corrected install-mac.md (#1005). Scope: docs/install-windows.md only.

Changes

  • Self-contained flow inside WSL2: Step 4 installs the agent CLIs (@anthropic-ai/claude-code, @openai/codex, @google/gemini-cli) + interactive auth; Step 5 installs QuadWork and verifies with npm list -g quadwork (example 2.7.0); Step 6 runs quadwork init / start, with quadwork stop in the shutdown section.
  • Multi-model behavior: documented the Agent Models step — per-role backend (Claude Code / Codex / Gemini CLI) plus optional per-role model selection (opus/sonnet, gpt-5.4/gpt-5.6-*, gemini-2.5-pro/-flash, or (CLI default)).
  • Worktrees & trust: project-head/dev/re1/re2 created next to the repo, seeded with AGENTS.md + CLAUDE.md; Claude trust prompt auto-answered at agent startup (no manual pre-trust).
  • Dashboard & shutdown: http://127.0.0.1:8400 (loopback, shared with Windows by WSL2); clean shutdown via ~/.quadwork/server.pid; pm2 background note.
  • Optional bridges: self-contained Discord/Telegram widget note (built-in, config in ~/.quadwork/config.json).
  • WSL-specific limitations retained only where accurate: caffeinate n/a, /home/<user>/ paths, VS Code WSL extension, shared localhost. Node aligned to 20+ (24 recommended).

EPIC Alignment

  • Batch 24 ticket docs(install-windows): Bring the WSL2 guide to current setup parity #1006 owns only docs/install-windows.md. This diff touches exactly that file.
  • Ticket requirement "do not merely point readers to an outdated Mac section": all Mac-guide deferrals removed; rg -i "identical|follow the mac|install-mac" docs/install-windows.md → no matches.
  • Out of scope, untouched: runtime code, tests, package versions, legacy cleanup/migration implementation, and all other docs (including install-mac.md).

Self-Verification

  • Command parity with the merged Mac guide / code:
    • Agent packages: @anthropic-ai/claude-code, @openai/codex, @google/gemini-cli (match docs/install-mac.md:61,64,67).
    • QuadWork: npm install -g quadwork@latest; verify npm list -g quadworkquadwork@2.7.0 (package.json version 2.7.0). quadwork --version is intentionally not used (not a subcommand — bin/quadwork.js dispatch has no version case).
    • Subcommands init / start / stop: bin/quadwork.js:1352-1361.
    • Dashboard loopback bind + auto-open: 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. caffeinate is macOS-only (server/index.js:311) → correctly "not applicable" on WSL2.
    • Backends + per-role models: src/components/SetupWizard.tsx:188-192, src/lib/agentModels.ts:10-45.
    • Worktree naming project-head/dev/re1/re2: bin/quadwork.js:630-631. Trust auto-answer: server/index.js:1182.
  • No Mac-deferral: rg -n -i "identical|follow the mac|install-mac|from the mac guide" docs/install-windows.md → no matches.
  • Scope: git diff --statdocs/install-windows.md only.
  • CI: pending on push.

Acceptance criteria

  • Guide is independently usable; does not merely point to the Mac section
  • CLI commands, prerequisites, authentication, worktree creation, dashboard access, and multi-model behavior verified against current code + corrected Mac guide
  • WSL-specific limitations retained only where accurate
  • No changes outside docs/install-windows.md

…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 project7-interns left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 1014docs/install-windows.md only; no install-mac or Mac-guide deferral remains.
  • Lifecycle claims: current head server/index.js:2324 binds the dashboard to loopback; bin/quadwork.js:928,947 auto-opens it and records server.pid.
  • Worktree/WSL limitation claims: bin/quadwork.js:630-631 names the four worktrees; server/index.js:301-316 makes 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 1014test 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.

@realproject7

Copy link
Copy Markdown
Owner Author

@re2 Independent Review — APPROVE ✅ (head a4a35ee)

Checked (evidence)

  • Self-contained (no Mac-guide deferral)git show <head>:docs/install-windows.md | grep -iE "identical|follow the mac|install-mac|Mac guide" → no matches; the WSL2 flow is fully inlined (Steps 3–6). ✓
  • Dashboard http://127.0.0.1:8400 (loopback) — dashboard server binds loopback at server/index.js:2324 (server.listen(PORT, "127.0.0.1", …)), default port 8400. WSL2 shared-localhost note is correct. ✓
  • Node.js 20+ (24 recommended) — enforced at bin/quadwork.js:313-320 (major >= 20 else fail) and package.json engines.node: ">=20". Doc's "20 or newer" + nvm-24 recommendation is accurate. ✓
  • Install verifynpm list -g quadwork (2.7.0 matches package.json); quadwork --version correctly avoided (not a subcommand — dispatch bin/quadwork.js:1351). ✓
  • Agent Models / per-role backendsBACKENDS (src/components/SetupWizard.tsx:188-191: Claude Code/Codex/Gemini CLI); per-role model via src/lib/agentModels.ts. ✓
  • Worktrees + seeds + auto-trust — AGENTS.md & CLAUDE.md seeds per worktree; trust prompt auto-answered via onData listener (server/index.js:1182-1190, [#S9] De-block the event loop (file-chat busy-wait, butler/setup execFileSync) #975 dropped synchronous pre-trust). ✓
  • Clean shutdown / server.pidquadwork start writes PID to ~/.quadwork/server.pid (bin/quadwork.js:945-951, [#S6] shutdown() cleanup + fix quadwork stop PID handling #972); quadwork stop reads it (stopPid, :987-990). ✓
  • Bridges built-in (Discord & Telegram)server/bridges/discord.js + server/bridges/telegram.js, with per-project widgets (DiscordBridgeWidget.tsx/TelegramBridgeWidget.tsx). ✓
  • Scopedocs/install-windows.md only (+135/−20); git diff --name-only origin/main → single file. ✓
  • CIgh pr checks 1014 → test pass (51s). ✓

Verdict: APPROVE on a4a35ee. (Recorded as a comment; shared bot account cannot self-approve on GitHub.)

@realproject7
realproject7 merged commit fbc870d into main Jul 17, 2026
1 check passed
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.

docs(install-windows): Bring the WSL2 guide to current setup parity

2 participants