Skip to content

docs: fix the install route and first-run docs before alpha.5 - #525

Merged
wstein merged 11 commits into
mainfrom
docs/523-pre-alpha5-doc-fixes
Oct 9, 2026
Merged

wstein merged 11 commits into
mainfrom
docs/523-pre-alpha5-doc-fixes

Conversation

@wstein

@wstein wstein commented Oct 9, 2026

Copy link
Copy Markdown
Owner

Fixes the findings of the pre-alpha.5 docs review (README, install page, host-setup, first-run, run-the-supervisor, troubleshooting, manual navigation):

  • First install now leads with the release archive (check, then sudo ./install.sh <tag>, no clone, no gh, no Command Line Tools); make install-release stays as the clone route. Order: archive install, /opt/whr/bin/whr setup host as the administrator, then whr setup as workharbor. The administrator is told how to reach /opt/whr/bin.
  • Paste blocks are stock-zsh safe (no comments, no literal placeholders, balanced quotes) and a new test covers every host-setup block.
  • Doctor: the prefix guide and the missing-guest-helper hint name the archive route and carry a custom prefix; the board message says three Status options.
  • Open point stated plainly: with a separate standard account nothing the administrator can run writes /etc/whr/config.json.
  • Navigation weights are unique, First run comes first; smaller wording fixes (gh in the Brewfile, Tailscale, WorkHarbor spelling, README).

Refs: #443

Review: Opus CLEAR on 38ee7c0 (full go test ./... and make check-ci exit 0, mutation proof for the zsh test). Open Low (batched on #399): host-setup.md step 13.1 and troubleshooting.md do not say to run the attestation check before an upgrade install. docs/releases/TEMPLATE.md and v0.1.0-alpha.5.md are updated in a separate notes PR. Unverified: any run on a real host.

🤖 Generated with Claude Code

wstein and others added 11 commits October 9, 2026 13:21
The prefix step told a first install to run make install-release, which needs
a clone, git, make and a prefix the account owns. It now names the archive
route. The board check message says three Status options, as it checks.

Refs: #443
Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
The host setup, first run and supervisor pages agree on the order, use the
full path for the administrator, say plainly what stays open with a separate
standard account, and keep paste blocks free of comments. A test parses the
host setup bash blocks in zsh.

Refs: #443
Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
@wstein

wstein commented Oct 9, 2026

Copy link
Copy Markdown
Owner Author

Opus review CLEAR on 38ee7c0 (reviewed twice: 3d754d9a, then the four Lows commits and the rebase onto #524). Full go test ./... exit 0 and make check-ci exit 0 on the head (author and reviewer scratch clone). The zsh paste-block test fails on a reverted block (mutation check). Low (batched on #399): host-setup.md step 13.1 and troubleshooting.md do not say to run the attestation check before an upgrade install. docs/releases/TEMPLATE.md and v0.1.0-alpha.5.md follow in a separate notes PR. Unverified: any run on a real host.

@wstein
wstein marked this pull request as ready for review October 9, 2026 11:39
@wstein
wstein merged commit fa6961e into main Oct 9, 2026
20 of 21 checks passed
@wstein
wstein deleted the docs/523-pre-alpha5-doc-fixes branch October 9, 2026 11:51
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.

1 participant