Skip to content

Onboarding: document the explicit "Start server" step (no more auto-start) - #9

Open
ronaldmannak wants to merge 1 commit into
masterfrom
claude/sharp-ptolemy-pdw04f
Open

Onboarding: document the explicit "Start server" step (no more auto-start)#9
ronaldmannak wants to merge 1 commit into
masterfrom
claude/sharp-ptolemy-pdw04f

Conversation

@ronaldmannak

Copy link
Copy Markdown
Contributor

Summary

Keeps the Install and Run getting-started page in sync with the onboarding rework merged in ronaldmannak/PicoServer since the last documentation run. All facts are grounded in the current source (OnboardingWizardView.swift at origin/main), not point-in-time PR descriptions.

The headline change: onboarding no longer auto-starts the server. The Ready page now has an explicit Start server button as the single commit point, then Open Chat (PicoServer #73). The Welcome/Access copy was also refreshed (PicoServer #59). The page in master still described a pre-wizard flow that set Open at login / Prevent sleep and implied auto-start, so it was stale on both counts.

What changed

  • Rewrote "Start the server" as the current four-step wizard — Welcome → Choose your first model → Choose who can connect → Ready — and made the explicit Start server button the point where the server actually starts. Added the note that navigating the wizard never starts or stops the server.
  • Open Chat now documents the WebUI hand-off, including the download-progress page shown when a model is still downloading.
  • Access step documents This Mac only (binds 127.0.0.1) vs Devices on my local network (binds 0.0.0.0) with the nested Bonjour option, matching the shipping strings.
  • Removed the stale claim that onboarding sets Open at login and Prevent sleep (no longer part of the reduced flow), and refreshed the Welcome button to Set up Pico.
  • New troubleshooting entry for the Ready step's Try again failure state (port already in use / server didn't respond).

Evidence

$ python3 .claude/skills/write-software-docs/scripts/check_markdown.py --strict \
    docs/user-guide/getting-started/install-and-run-pico-ai-server.md
Checked 1 file(s): 0 error(s), 0 warning(s)

Verified against ronaldmannak/PicoServer origin/main at 177b0c14 (after #73's merge): OnboardingWizardView.swift's WizardPage set (welcome/models/access/ready), the .continueTitle("Set up Pico") Welcome button, readyContinueTitle (Start server / Starting… / Open Chat / Restart server / Try again), the startServerFromButton() single-commit-point (save → start → reachability probe), recordStartFailure's "didn't respond on port …" message, and AccessPage's two options + nested Bonjour toggle.

Not done on purpose

  • PicoServer #63 (Ready-page footer contrast) and #74 (clear httpServerTask after terminal failure) — a cosmetic contrast tweak and an internal restart-cycle bug fix, respectively; no user-, admin-, or developer-facing surface to document.
  • PicoCore and PicoDocs — no PRs merged in this window (PicoCore's latest merge predates the last run; PicoDocs had none), so nothing to document there.
  • No developer-facing (API/reference) changes — no endpoint or API-shape changes landed in the window.

Relationship to the other open documentation PRs

This routine has opened one branch/PR per run, so several overlapping onboarding doc PRs are open against master and awaiting human review. This PR carries the newest truth:

Recommendation for the maintainer: land one onboarding PR (this one, as the most current) and close the older overlapping onboarding PRs (#5, #6, #7); keep #4 and #8 independent.


Generated by Claude Code

The onboarding Ready page no longer auto-starts the server. Update the
Install and Run guide to the current four-step wizard and the explicit
Start server / Open Chat flow.

- Rewrite "Start the server" as Welcome -> Model -> Access -> Ready, with
  the explicit "Start server" button as the single commit point.
- Refresh Welcome copy ("Set up Pico") and access choices ("This Mac only"
  vs "Devices on my local network") to match shipping strings.
- Remove the stale claim that onboarding sets "Open at login" and
  "Prevent sleep" (no longer part of the reduced flow).
- Add a troubleshooting entry for the Ready step's "Try again" failure.

Grounded in ronaldmannak/PicoServer OnboardingWizardView.swift at
origin/main (PicoServer #59, #73).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HUy41ab4FDBpeUukzGfN57
@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

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.

2 participants