docs(windows): the setup program is a real install route, so describe it (#1202) - #1212
Merged
Merged
Conversation
… it (#1202) `WairedSetup-<version>-x64.exe` is attached to every release and every edge prerelease, and it is a full install path: it elevates, registers the service, starts it, and turns on the Claude Code integration by default. docs.waired.ai described one route, the `iwr … | iex` line, and until #1199 did not name the setup program anywhere. The gap was not only cosmetic. packaging/windows/ sat outside docs-surface-guard's surface list until #1199 added it, so the GUI installer's behaviour could change with no docs page obliged to keep up — which is how getting-started/update.mdx came to promise a fresh-install behaviour only install.ps1 had. The release notes have also been telling people to "see SmartScreen note in docs" for a note that was not there. The new section covers what a person who downloads it actually meets, in order: no `latest/download/…` shortcut because the filename carries the version; "Windows protected your PC" and the way through it, which is why this page still leads with the PowerShell line; the permission prompt; a wizard that does not ask where to install and has one checkbox; that it does not run `waired init`, so signing in is still ahead of you; the log it always writes; in-place upgrade and uninstall, including that the state directory is kept by default; and the unattended switches with exit 0 / exit 7. The checkbox is described rather than quoted: its on-screen text is being rewritten by the auto-route retirement in flight, and a verbatim quote here would go stale the day that lands. Also widen the "What gets installed" Start Menu row: both installers create **Waired** and **Waired (CLI)**, and the table listed one. Fixes #1202 Refs #1181, #1199, waired-ai/waired#1312 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0172JQqxQSWDFbQauMDuCbJ2 Signed-off-by: gen16k <gen16k@users.noreply.github.com>
|
📘 Docs preview — the preview channel for this PR has been deleted now that it is closed. |
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.
What this is about
WairedSetup-<version>-x64.exeis attached to every release and everyedgeprerelease, and it is a full install path: it elevates, registers the service,
starts it, and turns on the Claude Code integration by default. docs.waired.ai
described one route — the
iwr … | iexline — and until #1199 did not name thesetup program anywhere on the site.
Two things had already gone wrong because of that gap:
packaging/windows/sat outsidescripts/ci/docs-surface-guard.sh's surfacelist until installer/windows: the GUI installer does not report success when it installed nothing (#1181) #1199 added it, so the GUI installer's behaviour could change with
no docs page obliged to keep up. That is how
getting-started/update.mdxcame to promise "A fresh install behaves thesame way: it stops rather than leaving a computer with programs that cannot
run" — true of
install.ps1, not of the GUI installer, which is WairedSetup: the GUI installer reports success and enables the Claude Code integration although the agent service was never installed — leaving Claude Code broken #1181.note in docs" (
.github/workflows/release.yml:207). There was no SmartScreennote in docs;
SmartScreenappeared nowhere underdocs-site/.Fixes #1202
Refs #1181, #1199, waired-ai/waired#1312 (L96)
What the section says
One new section,
## Install with the setup program, between "Read the scriptbefore running it" and "Skip the inference engine" — in the order a person
downloading it actually meets things:
latest/download/…shortcut (thefilename carries the version);
anyway), and that the PowerShell line does not raise it — which is why the
page still leads with that;
-InstallDiris the PowerShellroute's), and has one checkbox, under Claude Code integration:;
waired init, so signing in is still ahead of you,plus the finish-page checkbox and the two Start Menu entries;
SetupLogging=yessince installer/windows: the GUI installer does not report success when it installed nothing (#1181) #1199) — what you attach toa bug report;
%ProgramData%\wairedis kept by default so a reinstall re-uses the devicekey;
section installer/windows: the GUI installer does not report success when it installed nothing (#1181) #1199 added.
The opening line moves from "Installing is one command." to "Installing is one
command — or a setup program you double-click", so the page does not contradict
its own new section.
The checkbox is described, not quoted. Its on-screen text still says the
integration "transparently falls back to the real Anthropic API", and #1198 is
retiring exactly that behaviour. Quoting it here would go stale the day that
lands; the repo rule is that a wording fix changes the product string and its
docs together, so this page does not pin a string that is already moving.
Also: the "What gets installed" table listed Waired as the only Start Menu
entry. Both installers create Waired and Waired (CLI)
(
waired-setup.iss[Icons],install.ps1New-StartMenuShortcuts), so therow now says both.
Verification
packaging/windows/waired-setup.iss(
DisableDirPage=yes,SetupLogging=yes, theclaudeproxytask and itsgroup label, the finish-page description, exit 7 from
PrepareToInstall, theuninstall prompt defaulting to No,
UninstallSilentkeeping state) andpackaging/windows/README.md§"Code signing (deferred)" for the SmartScreenwording.
npm run i18n:check: 32 pairs, all in sync; the ja mirror keeps the sameheadings and fenced blocks.
astro buildwas not run locally (nonode_modulesin this checkout); thedocs-site build job on this PR is the check.
Not in scope
Screenshots of the wizard, and a page of its own. If the setup program becomes
a route we recommend rather than tolerate, that is the moment for both — and it
is gated on signing (waired#759), which is also what would remove the
SmartScreen paragraph.
🤖 Generated with Claude Code
https://claude.ai/code/session_0172JQqxQSWDFbQauMDuCbJ2