docs: one answer on Windows support — macOS and Linux only (BEA-77) - #126
Open
ssowonny wants to merge 1 commit into
Open
docs: one answer on Windows support — macOS and Linux only (BEA-77)#126ssowonny wants to merge 1 commit into
ssowonny wants to merge 1 commit into
Conversation
"Can my Windows teammate join?" got three answers from three official surfaces: README's feature list said macOS & Linux, its CLI table documented an HKCU Run entry on Windows, and the hub's Installation page named no OS at all. Windows autostart is real code that cannot run — internal/store's flock and internal/daemon's Kill/Setsid are unix-only, so GOOS=windows does not build. The fix is the docs, not the port: every Windows claim comes out of README, web/docs and `bdrive autostart`'s own help, and the Installation page gains one line naming the supported systems. No Go source is deleted; internal/autostart/autostart_windows.go stays compiled-but-dormant for whenever the port happens.
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.
TL;DR
GOOS=windows go build ./...still fails oninternal/storeandinternal/daemon, exactly as before. This PR does not move the port an inch — it stops the docs from promising it.The fork this closes
flowchart TD Q["can my Windows teammate join?"] Q --> A["README:115<br/>'macOS & Linux.'<br/><b>no</b>"] Q --> B["README:234 + docs cli.md<br/>'an HKCU Run entry on Windows'<br/><b>yes</b>"] Q --> C["hub Installation page<br/>names no OS at all<br/><b>???</b>"] A --> R["after: macOS and Linux.<br/>Windows is not supported yet."] B --> R C --> R style R fill:#2d6a4f,color:#fffTwo personas hit this independently on the persona tour. Ken read the Installation page to decide whether his second machine was supported, found no operating system named anywhere on it, then grepped the README and got two more answers.
The underlying fact was verified by cross-compiling rather than by trusting either doc:
GOOS=windows GOARCH=amd64 go build ./...fails on exactly two files —internal/store/store.go(syscall.Flock) and eleven sites ininternal/daemon/daemon.go. Everything else in the module cross-compiles clean, which is precisely why the docs read as contradictory rather than merely incomplete: the Windows autostart support is real code that genuinely cannot run. The fix is the docs, not the port (the port was scored XL and gated no).The eight edits
README.md:234autostart row, an HKCU Run entry on Windowsclauseweb/docs/…/reference/cli.md:16web/docs/…/manual/hooks.mdweb/docs/…/manual/hooks.mdcmd/bdrive/resume.goLongbdrive autostart --helpcmd/bdrive/resume.go×2(needs macOS, Windows, or Linux with systemd)→(needs macOS, or Linux with systemd)ConnectGuide.tsxgd-descline naming the supported systemsREADME.md:115,INSTALL_FOR_AGENTS.mdandmanual/install.mdalready said macOS and Linux — untouched.The new line lands on two surfaces, deliberately
ConnectGuideis rendered by both/<project-id>/install(HubApp.tsx:257) and the project home (Browser.tsx:445). One edit, two places — same question, same answer, so this is the right outcome rather than a stray edit. Both are shown below.The same line on the project home, sitting above Knowledge insights:
What was run
go build ./...,go vet ./...,go test ./...— all pass.cmd/bdrive/autostart_help_test.gowalks theautostartcommand tree and fails if anyShort/Longmentions Windows. The twofmt.Printlnlines fire only onautostart.ErrUnsupported, which macOS/Linux CI never reaches — they ride the same edit and are covered bygrep -n Windows cmd/bdrive/resume.goreturning nothing.npm run buildininternal/webapp/frontend+ committedstatic/;check-dist.shsays fresh; the new sentence greps out ofstatic/assets/.npm run e2e— 153 passed, 1 pre-existing skip.npm run buildinweb/docs— 26 pages, clean with the removed rows.grep -rni windows README.md web/docs/src/content/docs/andgrep -n Windows cmd/bdrive/resume.goboth return nothing.Two things to carry, no action
CLAUDE.mdand.claude/security-goal.mdboth discuss the Windows autostart path at length. Both are developer documentation and stay — a repo-widegrep -rni windowswill never come back clean, by design.internal/webapp/staticconflicts with any other frontend branch (BEA-78/79/80 all rebuild it). Resolve by re-runningnpm run buildon the merge result — never by picking a side.Still open
The spec read "the landing page" as the hub's own Installation page — the page Ken actually read. If beardrive.ai was meant instead, that lives in the separate private cloud repo and needs its own ticket; the same sentence should be mirrored there either way. Nothing in this PR depends on the answer.
Build session
(only works on this machine)
Closes BEA-77.