Skip to content

Replay onboarding: Show Welcome and Get Started checklist from Help - #95

Merged
marcellosso merged 1 commit into
mainfrom
feat/replay-onboarding
Nov 13, 2026
Merged

marcellosso merged 1 commit into
mainfrom
feat/replay-onboarding

Conversation

@marcellosso

Copy link
Copy Markdown
Owner

Closes #94

What changed

Two actions replay onboarding on request, with the same labels in both apps:

  • Show Welcome… opens the existing welcome sheet, even when Projects exist. The steps, copy and design are unchanged. Skip, Not Now and Escape close it, and Add Project… opens the Add Project sheet, as on first run. The saved hasSeenWelcome is already true for anyone who can see this, so nothing is written.
  • Show Get Started Checklist sets isChecklistDone back to false. The checklist comes back at the foot of the sidebar and still ticks from real state. It needs at least one Project to show, as before.

Asking for the checklist sets a flag that is kept in memory only (isChecklistReplayed). While it is set, the checklist does not close itself when every row is ticked. Without it, a user with Projects, a Running Service and a connected agent would see the checklist close straight away. It stays until × is clicked, and the flag is gone at the next launch.

Where each action lives

macOS (SwiftUI) Linux / Windows (Tauri)
Menu Help menu, below Keyboard Shortcuts (separated by a divider). Each action opens the main window first. Help menu: the footer's ? button at the foot of the sidebar, which opens upward. It holds Keyboard Shortcuts, a separator, then the two actions.
Command palette other:show-welcome and other:show-checklist: they show when you type for them (e.g. "welcome", "onboarding", "get started"), like Check for Updates… Same ids and keywords.

Why the sidebar footer on Tauri: the Tauri window has no native menu bar. Its only help-type control was the Keyboard Shortcuts button in the sidebar footer, next to Settings. The tray is meant for quick Service controls, not a second app (see AGENTS.md, Design). So that button is now a Help menu (a ? icon), which matches the macOS Help menu entry for entry. Keyboard Shortcuts is still one click away in that menu, and also on Ctrl+/ and in the palette. To open the menu upward, Menu gained an isAbove option.

Not changed

First-run rules for new users, the existing-user logic at launch (atLaunch / onboardingAtLaunch), hasStartedService, Projects, Services and user folders. No telemetry and no version numbers. Docs: one added sentence in site/src/content/docs/quick-start.md, and "it doesn't come back" now reads "it doesn't come back by itself".

How it was checked

  • apps/desktop: pnpm typecheck and pnpm test pass (26 files, 132 tests). New tests:
    • Onboarding.test.tsx › Help: Show Welcome… opens the welcome with a Project present and saves nothing on Skip. Show Get Started Checklist brings back a checklist that was closed. A fully ticked one (4 of 4) stays until ×, which saves isChecklistDone: true again. A partly ticked one shows 2 of 4.
    • palette.test.ts: both items are offered when typed for, and Show Welcome… opens the welcome sheet.
  • macOS: scripts/build-core.sh debug and the xcodebuild Debug build both succeed, with no new warnings. The macOS app has no test target, so its changes mirror the tested desktop logic.
  • No screenshots. The installed localhost app was running on this machine, and the debug build has the same bundle ID and onboarding UserDefaults keys. Clicking Show Get Started Checklist there would have changed the real app's saved state. Please check Help › Show Welcome… and Help › Show Get Started Checklist (and the sidebar ? on Linux/Windows) in light and dark before merging.

Left out

  • No changelog entry, as asked.
  • No keyboard shortcuts for the two actions: they are rare, and the palette covers keyboard use.

@vercel

vercel Bot commented Nov 13, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
localhost-web Ready Ready Preview Nov 13, 2026 6:36pm UTC

@marcellosso
marcellosso merged commit eaaafc6 into main Nov 13, 2026
12 checks passed
@marcellosso
marcellosso deleted the feat/replay-onboarding branch November 13, 2026 18:57
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.

Replay onboarding: Show Welcome and Get Started checklist from the Help menu

1 participant