Skip to content

Add "Tour the Menu Bar" page and correct the onboarding wizard steps - #7

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

Add "Tour the Menu Bar" page and correct the onboarding wizard steps#7
ronaldmannak wants to merge 1 commit into
masterfrom
claude/sharp-ptolemy-pei573

Conversation

@ronaldmannak

Copy link
Copy Markdown
Contributor

Summary

Keeps the Getting Started docs in sync with menu-bar and onboarding changes merged in ronaldmannak/PicoServer since the last documentation run. All facts are grounded in the current source (MenuExtraView.swift, OnboardingWizardView.swift), not point-in-time PR descriptions.

What changed

  • New page — "Tour the Menu Bar" (docs/user-guide/getting-started/tour-the-menu-bar.md). Documents the shipping menu-extra panel, which is the primary control surface: Server status (dot + label + Start/Stop + address copy), the Memory bar (Apps / MLX / Free) with the GB / % legend toggle (PicoServer #37) and the Pressure indicator, Models in Memory (states Loading/Active/Idle, per-model evict, Clear All), the Downloads progress section, and the actions menu (Open Pico Web Chat, Documentation, Settings…, Setup Wizard…/Open Discord under Option, Quit). Includes a runnable verification and troubleshooting.
  • Corrected the onboarding step on Install and Run to the actual four-step wizard — Welcome → Model → Access → Ready (PicoServer #42/#48) — and removed the stale claim that onboarding sets Open at login and Prevent sleep; the reduced flow no longer exposes those.
  • Sidebar wiring — added the new page to the Getting Started category in sidebars.ts (slot 2, matching the docs map's "Tour the Dashboard" intent) and bumped sidebar_position on configure-settings (3) and connect-a-client (4).

Evidence

$ python3 .claude/skills/write-software-docs/scripts/check_markdown.py --strict \
    docs/user-guide/getting-started/tour-the-menu-bar.md \
    docs/user-guide/getting-started/install-and-run-pico-ai-server.md \
    docs/user-guide/getting-started/configure-settings.md \
    docs/user-guide/getting-started/connect-a-client.md
Checked 4 file(s): 0 error(s), 0 warning(s)

Verified against ronaldmannak/PicoServer master at the #49 merge (9088e48): MenuExtraView.swift's serverSection/memorySection/modelsSection/downloadsSection/actionsSection and the memoryLegendShowsPercent GB/% toggle; OnboardingWizardView.swift's welcome/models/access/ready pages.

Not done on purpose

  • Menu-extra "Inference" section (PicoServer #34) — not documented. In release builds inferenceProvider is nil, so the Inference section never renders for end users (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.
  • Specific model tiers / "Reasoning" rename (PicoCore #54) — not enumerated. The onboarding Model step is documented generically ("recommends a starting model based on your Mac's memory"); the RAM-tier catalog's model names/IDs are flagged as TODO placeholders in source (Reasoning-tier models render as "Coming soon"), so naming them now would go stale.
  • PicoCore admin promote/demote (#67) and blank-token rejection (#68) — no user-facing Server UI surface identified for these engine-level APIs; documenting a UI that may not exist yet would be inventing behavior. Deferred.
  • PicoServer #49 and PicoCore #65/#53/#51/#52 — internal/durability/CI/wire-format changes with no end-user, admin, or developer-facing surface. PicoDocs had no merged PRs in the window.

Relationship to the other open documentation PRs

This routine has opened one branch/PR per run, so several overlapping doc PRs are now open against master and awaiting human review:

Recommendation for the maintainer: merge one onboarding PR (this one or #6) and close the other, close #5, and keep #4 independent — the three onboarding/menu-bar PRs should not all land.


Generated by Claude Code

Keeps the getting-started docs in sync with changes merged in PicoServer
since the last documentation run.

- New page "Tour the Menu Bar" documenting the shipping menu-extra: server
  status + Start/Stop + address copy, the Memory bar with the GB/% legend
  toggle (PicoServer #37), Models in Memory (states, evict, Clear All), the
  Downloads section, and the actions menu.
- Rewrite the onboarding step on "Install and Run" to the actual four-step
  wizard (Welcome, Model, Access, Ready) and drop the stale claim that
  onboarding sets "Open at login" and "Prevent sleep" (PicoServer #42/#48).
- Wire the new page into the sidebar and adjust sidebar_position ordering.

Deliberately omits the menu-extra "Inference" section (release builds keep
its provider nil, so it never renders for end users) and specific model-tier
names (flagged as TODO placeholders in PicoCore source).
@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.

Copy link
Copy Markdown
Contributor Author

Noting for the record: the expected automated internal-contradiction review does not appear to be running here — gemini-code-assist[bot] reports it has been sunset and its review activity has ceased. No findings to address from it. If Codex (the other configured reviewer) posts findings, they'll be handled; otherwise this PR is awaiting human review.

This PR is intentionally self-contained but overlaps the other open documentation PRs on the onboarding paragraph — see the "Relationship to the other open documentation PRs" section in the description for the recommended consolidation (merge one onboarding PR, close #5, keep #4 independent).


Generated by Claude Code

@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.

1 participant