Repository navigation
Description
Part of #1692.
Scope
A Windows user reads on the website that a Windows PC can be an Android worker, and follows one page, "Set up a Windows worker", from installing Node to a released Android lease, in PowerShell. Every other page that names where Simlock runs agrees with it.
If this task goes wrong, a Windows user hits a step on the page that fails as written, or reads "macOS or Linux" on one page and "Windows" on another.
Technical spec
Commit 2df19f8.
Rows
Behaviours: B1, B2, B3, B4, B5, B6
Existing code: X1, X2, X3, X4, X5, X6, X7, X8, X9, X10, X11, X12, X13, X14, X15, X16, X17, X18, X19, X20, X21, X22, X23, X24, X25, X26, X27, X28, X30, X31, X32, X33, X34
Facts
| # | Fact | Source |
|---|---|---|
| F1 | The website build and its API check are one toolchain line | docs/internal/agent-rules/toolchain.md:19 |
| F2 | The sidebar's Worker group lists its pages with doc("worker/<name>", "<label>") |
website/astro.config.mjs:112 to :124 |
| F3 | DesktopWindows takes commands as .ps1 files copied with scp and run with powershell -NoProfile -ExecutionPolicy Bypass -File <file>; its default ssh shell is cmd.exe; the SDK is at D:\Android\Sdk, a clone at D:\dev\simlock; another session's emulator shows as qemu-system-x86_64.exe in tasklist, and only one emulator runs at a time; another session's worker on the same user makes daemon start fail with another Simlock worker runs for this user |
maintainer's brief for #1692 (2026-11-18), and tasklist /FI "IMAGENAME eq qemu-system-x86_64.exe" run in the #1692 session |
Modules touched
Searches: rg -n "macOS or Linux|Mac or Linux|Macs and Linux|Mac and Linux" website/src README.md (12 hits), rg -n -i linux website/src --glob '!content/docs/**' (13 hits), rg -n "NO_DRIVER" website/src/content/docs, rg -n "daemon.sock" website/src/content/docs/docs/worker.
website/src/content/docs/docs/worker/windows.mdx(new) andwebsite/astro.config.mjs(sidebar).website/src/content/docs/docs/introduction/(requirements.mdx,index.mdx,how-it-works.mdx),getting-started/index.mdx,using-devices/choosing-a-device.mdx,gateway/index.mdx,worker/running-the-daemon.mdx,reference/errors.mdx.website/src/site/content.tsandREADME.md.
No file under src/ changes.
Rules in play
docs/internal/agent-rules/documentation.mdrule 1 and rule 9: end-user docs only on the website; the new page joins the sidebar.docs/internal/agent-rules/documentation.mdrule 2: the page cites no ADR and links nowhere underdocs/internal/.docs/internal/BRAND.md: the home page's headline, description and animation stay as they are.
Tests
Seam: the website pages, built with the website line of toolchain.md (F1). This task adds no test file: src/docs-audience.repo.test.ts, which already reads every page, must still pass, as in #1671 (23cfd6f). The B2 to B4 commands are run on DesktopWindows (F3).
- B1: Requirements lists macOS, Linux and Windows for each "At a glance" row: the CLI, iOS simulators, Android emulators, a gateway, a physical iPhone, a physical Android phone, start at login; it links to the Windows page.
- B2: the Windows page's steps from
simlock doctoron, run in Windows PowerShell 5.1 on DesktopWindows in one script per ssh session with its ownSIMLOCK_HOMEunderD:\sv\: doctor with no findings; licenses accepted and an image installed; a lease granted;simlock adb -s <device.address> shell getprop ro.build.version.releaseanswers; the lease released; a JSONconfig setin the page's escaped form is stored as an object. - B3: the Windows page's three lists hold exactly the items of B3, each "works" item backed by its X row (X25 and X34 for the maintainer's runs).
- B4: the Windows page states the data folder,
SIMLOCK_HOME, the named pipe, theicaclswarning, the one-account caution, and how the daemon lives when the terminal closes and over SSH. - B5: no line in
website/srcorREADME.mdsays the CLI, Android emulators or a gateway run on macOS or Linux only; the home page gains its Windows entries and keeps its headline. Decision: the FAQ answers Windows and Linux in one entry, "Can a Windows or Linux machine be a worker?", so the 3-column grid keeps six entries and no half-empty row (BRAND.md); Tests: the website build and the home page FAQ hold six entries, one naming Windows (decided in delivery, pending the maintainer) - B6: Install and check your machine links to the Windows page and names the Windows data folder.
Done when
pnpm --dir website install && pnpm --dir website build && node website/scripts/check-openapi.mjspasses.rg -n "macOS or Linux|Mac or Linux|Macs and Linux" website/src README.mdprints only lines aboutdaemon install, the site description (website/src/site/content.ts:24) and the animation caption (website/src/components/home/story.ts:57), which B5 keeps.- Before review, the implementer runs the Windows page's commands from
simlock doctorto the released lease, and its JSONconfig setexample, on DesktopWindows as F3 describes:- in one script per ssh session (a daemon started over SSH stops when the session ends);
- with
SIMLOCK_HOMEset to a new folder underD:\sv\(neverD:\sv\homeorC:\Users\Szymon\.simlock); - with
simlockbuilt from the branch:git worktree add D:\dev\task1701 <branch>inD:\dev\simlock,pnpm installandpnpm buildthere, andnode D:\dev\task1701\dist\cli\main.jsin place ofsimlock, because the published 0.8.0 lacks the Windows fixes the page describes; - on the machine as it is set up: it does not change the user's
Path,ANDROID_HOME, script policy, Windows features or SDK packages; those steps rest on the feature's X13, X14, X27 and X28; - only when no
qemu-system-x86_64.exeruns anddaemon startdoes not answeranother Simlock worker runs for this user; it retries every 20 s for up to 40 minutes, then hands back as busy.
The PR description holds the script's output. The implementer removes its worktree and home afterwards.
- If Windows: simlock daemon install runs the daemon from a logon task with a Simlock supervisor #1698 (Windows start at login) has merged when this task is built, the pages list start at login under what works on Windows, and link to Run the daemon, in place of "not on Windows yet".
Out of scope
- Start at login on Windows (Windows: simlock daemon install and uninstall run the daemon as a service #1691) and a Windows CI job (CI: run the tests on Windows #1693): those features change these pages when they ship.
- Physical Android phones on Windows: the page lists them as not checked.
- The daemon-stop timeout seen while a seed was being remade: bug Windows: daemon stop times out after 300 s while the warm pool remakes an Android seed (EBUSY on cache.img) #1700.
- cmd.exe commands.
Depends on
Written by an agent.
Activity
docs(website): the home FAQ holds six entries, so its 3-column grid h…