Skip to content

Update onboarding docs for new Welcome/Model/Access/Ready flow - #6

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

Update onboarding docs for new Welcome/Model/Access/Ready flow#6
ronaldmannak wants to merge 1 commit into
masterfrom
claude/sharp-ptolemy-iuh1da

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, MenuExtraView.swift), not point-in-time PR descriptions.

What changed

  • Onboarding is now a four-step wizard — Welcome → Model → Access → Ready (PicoServer #42, #48). Rewrote step 2 to describe the actual flow.
  • Model step — documents the RAM-based recommended model (preselected), the choice to download / pick another / skip, and that a download continues in the background (PicoServer #38).
  • Access step — documents This Mac only vs Devices on my local network, with Bonjour discovery as a nested option shown only when LAN access is on. Updated the LAN / local-only steps to name these choices.
  • Removed the stale claim that onboarding sets Open at login and Prevent sleep. The reduced flow (#42) no longer exposes those; the page now notes they live in the native app settings.
  • Ready step + menu extra — documents the Ready page's live status/model/access/address display, the download-progress hand-off, and the menu extra's Memory section (Apps / MLX / Free bar + pressure indicator) and Models in Memory list.

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 main at the #49 merge (9088e48): the wizard's WizardPage set (welcome/models/access/ready), AccessPage's two options + nested Bonjour toggle, ReadyPage's status/model/access/address rows, and MenuExtraView's Memory and Models in Memory sections.

Not done on purpose

  • PicoServer #34 (menu-extra "Inference" section) — not documented. In release builds inferenceProvider is nil, so the Inference section never renders for end users (the source comment: "Release builds keep this nil so the Inference section never shows fabricated numbers"). Documenting a DEBUG-only, placeholder-data section would be inaccurate; deferred until it ships in release.
  • PicoCore #54 (Reasoning-tier rename / RAM tier catalog) — not enumerated. The Model step already documents the RAM-based recommendation generically; specific tier names/model IDs are still in flux (the prior run's PR Document onboarding notifications toggle and menu-extra memory section #5 flagged the same), so naming them now would risk going stale.
  • PicoServer #49 (conversation store kept out of the shared app group, in-memory for now) and PicoCore #65/#53/#51 — internal/durability/wire-format changes with no user-, admin-, or developer-facing surface. Nothing to document.
  • No developer-facing (API/reference) changes: no endpoint or API-shape changes landed in the window, and PicoDocs had no merged PRs.

Relationship to other open documentation PRs

🤖 Generated with Claude Code


Generated by Claude Code

The first-run flow was reworked in PicoServer (#38, #42, #48): it is now
a four-step Welcome -> Model -> Access -> Ready wizard that picks a first
model (RAM-based recommendation + background download) and sets network
access, rather than a toggle list including Open-at-login / Prevent-sleep.
Correct the Install and Run page to match the shipped flow and note the
menu extra's Memory and Models-in-Memory sections.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0171A1mZB4sL46Wy2pbwDJCu
@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