Repository navigation
First-run onboarding: welcome, guided empty states and a Get started checklist - #91
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #90
What changed
A short first run in both apps, with the same words, step order and timing in each.
Welcome (first launch only). Three steps in a sheet, each with a small mock of the window and no version numbers:
pnpm devordocker compose upIt has Skip (Not Now on the last step), Back and Continue. The last step's primary action is Add Project…, which opens the existing Add Project sheet (scan + Suggestions review). Escape, Skip, Not Now and finishing all mark it seen, so it never opens again. It opens after the unreadable-files and Orphans questions, never on top of them.
Guided empty states.
+: macOS now opens the same menu as Linux/Windows (New Project…, Import Project…). ⌘N and the File menu are unchanged.Get started checklist. Shown at the foot of the sidebar, above the telemetry notice, once a Project exists. Its rows: Add a project, Add a service, Start your first service, Connect your agents (optional).
AgentSetup's statuses (re-read whenever a sheet closes).Connect your agents no longer opens by itself at the first launch. It's offered from the checklist and is still in Settings › Agents, the command palette and the empty state.
Where the state lives
App settings only, never Project Configuration, Project files or the user's folders:
onboardingobject (hasSeenWelcome,isChecklistDone,hasStartedService) in the app'ssettings.json, through two commands,onboarding/save_onboarding. These replacetake_connect_agents_offer.onboardingHasSeenWelcome,onboardingChecklistDone,onboardingHasStartedService.Existing users
The record is decided once, at the first launch of this version, and saved:
hasOfferedAgents/hasOfferedConnectAgents; on Linux/Windows also the close explanation), is marked done. They see neither the welcome nor the checklist.Telemetry
No events added. The core documents
app_first_openandapp_openedas the only events, and the notice and Settings say data is sent "when localhost opens". The issue keeps that notice unchanged, so adding onboarding events would make it inaccurate.docs/analytics.mdand the privacy page are unchanged. This would be easy to add later, together with new notice wording.Docs
quick-start.md: describes the first run, and step 1 now starts from Add Project… / the+menu.mcp.mdand the README: no longer say the agents sheet opens by itself.configuration.md: the+menu now exists on both platforms.AGENTS.md: a product rule for the first run.No changelog entry.
How it was checked
apps/desktop:pnpm typecheck,pnpm test(128 tests, including new ones),pnpm build.onboarding.test.ts: first launch vs. opened before vs. already has Projects, never again once seen, the checklist ticking from real state (Starting doesn't count, Running stays ticked), and agents counting.Onboarding.test.tsx: walking the welcome to Add Project…, Escape, the checklist actions, auto-hide when complete, ×, and nothing for existing users.src-tauri:cargo test(new settings tests, including reading an earlier version'ssettings.json),cargo clippy --all-targets -D warnings,cargo fmt --check.bindings.tsregenerated.scripts/build-core.sh debugand anxcodebuildDebug build. The app has no test target, so its logic mirrorsonboarding.tsinOnboarding.swift, and the Tauri tests cover the rules.Reset onboarding to test it
Use
LOCALHOST_STORAGE_ROOT=/tmp/localhost-devso you have no Projects. Then:defaults delete io.github.marcellosso.localhost onboardingHasSeenWelcome; defaults delete io.github.marcellosso.localhost onboardingChecklistDone; defaults delete io.github.marcellosso.localhost onboardingHasStartedService; defaults delete io.github.marcellosso.localhost hasOfferedConnectAgents. You can also launch with-onboardingHasSeenWelcome NO -onboardingChecklistDone NO -onboardingHasStartedService NO -hasOfferedConnectAgents NOto override without writing.onboarding,hasOfferedAgentsandhasExplainedClosekeys fromsettings.jsonin the app's config folder (~/.config/io.github.marcellosso.localhost.desktop/,%APPDATA%\io.github.marcellosso.localhost.desktop\).Left out
Machines in first-run, a sample Project, sign-in, coach marks, changes to the telemetry notice, and telemetry events (see above).