Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
9897739
feat: add product coachmark onboarding tours
pythongosssss Jun 23, 2026
cc74e1d
add assets step to app mode tour
pythongosssss Jun 24, 2026
75af043
- change dialog to use standard component
pythongosssss Jun 25, 2026
f80deb9
[automated] Apply ESLint and Oxfmt fixes
actions-user Jun 29, 2026
f642384
change dash stroke to solid
pythongosssss Jun 30, 2026
5e23f76
fix: address coachmark tour review feedback
pythongosssss Jun 30, 2026
c51f963
trim comments
pythongosssss Jun 30, 2026
e9729ca
drop blankCanvas tour
pythongosssss Jun 30, 2026
f973626
improve test coverage
pythongosssss Jun 30, 2026
5dbb560
refactor + tidy
pythongosssss Jun 30, 2026
88cd848
fix test
pythongosssss Jun 30, 2026
fdfa988
feat: make app-mode tour explicit-only and refine assets step
pythongosssss Jun 30, 2026
5118212
feat: auto-open app-mode tour for populated apps
pythongosssss Jun 30, 2026
07356e3
tidy
pythongosssss Jun 30, 2026
b65da23
refactor: slim coachmark target tracking and spotlight chrome
pythongosssss Jun 30, 2026
87d0a11
fix: close the coachmark landing on Escape explicitly
pythongosssss Jun 30, 2026
a818b7e
test: open the template browser in the coachmark drift guard
pythongosssss Jun 30, 2026
9b8dd27
refactor: gate coachmark tour listeners behind an active-step component
pythongosssss Jun 30, 2026
5383e23
Merge origin/main into pysssss/product-coachmarks
pythongosssss Jul 1, 2026
3f84d4f
test: cover forced tour start, button labels, and spotlight escape
pythongosssss Jul 1, 2026
64d10da
refactor: place coachmark cards with Floating UI
pythongosssss Jul 1, 2026
831813a
fix: stop coachmark spotlight polling once its target settles
pythongosssss Jul 1, 2026
ce8b107
fix: correct coachmark tour skip telemetry and one-shot forcing
pythongosssss Jul 1, 2026
2312b21
refactor: address coachmark tour review feedback
pythongosssss Jul 1, 2026
96c2ae1
feat: add landing image to the app-mode tour
pythongosssss Jul 1, 2026
549200a
fix: address coachmark tour stacking, telemetry, and fixture review n…
pythongosssss Jul 2, 2026
e97746f
refactor: address coachmark tour PR feedback
pythongosssss Jul 2, 2026
e7cdfc8
chore: ignore derived coachmark keys in the unused-i18n check
pythongosssss Jul 2, 2026
9bcfda8
refactor: reconcile v-coachmark from the element's own data-coach-id
pythongosssss Jul 2, 2026
76abe8e
Merge branch 'main' into pysssss/product-coachmarks
pythongosssss Jul 2, 2026
bb39a51
fix: narrow the coachmark i18n exemption to derived step keys
pythongosssss Jul 2, 2026
7630cc9
fix: use the generic Skip label on the coachmark tour landing
pythongosssss Jul 3, 2026
61756e9
fix missing modal backdrop
pythongosssss Jul 3, 2026
9a71b54
refactor: move the coachmark tour state machine into a Pinia store
pythongosssss Jul 6, 2026
ccb3cd4
fix: restore the coachmark landing's md max-width
pythongosssss Jul 6, 2026
9730850
fix: keep the coachmark tour alive when outputs clear
pythongosssss Jul 6, 2026
25ce1eb
Merge remote-tracking branch 'origin/main' into pysssss/product-coach…
pythongosssss Jul 6, 2026
f1f7c53
feat: rework coachmark assets step and add step-back navigation
pythongosssss Jul 6, 2026
7df585e
flush -> nextTick
pythongosssss Jul 6, 2026
3f5b71a
refactor: use reka FocusScope for coachmark focus trapping
pythongosssss Jul 7, 2026
cb1be63
decrease padding
pythongosssss Jul 8, 2026
66b9f32
update wording
pythongosssss Jul 8, 2026
dff76db
make button grow, match design
pythongosssss Jul 8, 2026
62806d5
Merge branch 'main' into pysssss/product-coachmarks
pythongosssss Jul 9, 2026
13fd072
Merge branch 'main' into pysssss/product-coachmarks
AustinMroz Jul 13, 2026
62bb4d4
Merge remote-tracking branch 'origin/main' into pysssss/product-coach…
MaanilVerma Jul 17, 2026
e9caa31
test(onboarding): fix the coachmark drift-guard's assets-tab selector
MaanilVerma Jul 17, 2026
fcd151d
feat(onboarding): accept virtual coachmark targets
MaanilVerma Jul 25, 2026
b8c7035
feat(onboarding): add step onEnter hooks and async tour resolvers
MaanilVerma Jul 25, 2026
daef85f
feat(onboarding): mask-based scrim for interactive steps
MaanilVerma Jul 25, 2026
44a383e
feat(first-run-tour): resolve canvas nodes as coachmark targets
MaanilVerma Jul 25, 2026
1389a48
refactor(first-run-tour): drop the unused canvas union rect
MaanilVerma Jul 26, 2026
76d612c
refactor(onboarding): spotlight one target, drop the unused extra mas…
MaanilVerma Jul 27, 2026
0f93f63
refactor(first-run-tour): map canvas targets with litegraph's own camera
MaanilVerma Jul 27, 2026
2b4516e
Merge main
AustinMroz Jul 27, 2026
613ab51
Merge branch 'pysssss/product-coachmarks' into feat/tour-engine-canva…
MaanilVerma Jul 27, 2026
c671e33
Merge main (again)
AustinMroz Jul 27, 2026
45b1e53
refactor(onboarding): follow the camera instead of polling the target
MaanilVerma Jul 28, 2026
1cfccec
refactor(onboarding): position the card from the target itself
MaanilVerma Jul 28, 2026
9a5d2be
refactor(onboarding): target canvas nodes by selector, not camera maths
MaanilVerma Jul 29, 2026
08306cf
refactor(onboarding): the engine follows selector targets, nothing an…
deepme987 Jul 29, 2026
eb210bf
refactor(onboarding): nodes self-register through vCoachmark; a follo…
deepme987 Jul 29, 2026
49d5ccb
refactor(onboarding): strip the engine to what the graph tour consumes
deepme987 Jul 29, 2026
f1e371e
refactor(onboarding): drop the per-node directive; tours register the…
deepme987 Jul 29, 2026
eece6c8
Merge branch 'main' into deepme987/onboarding/selector-targets-lite
deepme987 Jul 29, 2026
c757a88
refactor(onboarding): the canvas is locked during a tour, nothing fol…
deepme987 Jul 29, 2026
c679194
refactor(onboarding): next on the last step already completes
deepme987 Jul 29, 2026
069aa16
refactor(onboarding): tour definitions build synchronously
deepme987 Jul 29, 2026
03082ec
refactor(onboarding): whenever reads the trigger intent directly
deepme987 Jul 29, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 26 additions & 13 deletions src/platform/onboarding/onboardingTourStore.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { whenever } from '@vueuse/core'
import { defineStore } from 'pinia'
import { computed, ref, shallowRef, watch } from 'vue'

Expand Down Expand Up @@ -127,6 +128,14 @@ export const useOnboardingTourStore = defineStore('onboardingTour', () => {
}
}
stepIdx.value = idx
if (nextStep.onEnter) {
try {
await nextStep.onEnter(signal)
} catch (error) {
if (!signal.aborted) console.error('coachmark onEnter failed', error)
}
if (signal.aborted) return
}
Comment on lines +131 to +138

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Do not mark a failed entry hook as shown.

A non-abort onEnter rejection is only logged, then execution falls through to trackTour('step_shown'). The user can be shown a step whose setup failed. Surface an actionable error and stop/skip the tour without marking it seen, or propagate the failure to the caller.

As per coding guidelines, source code must provide user-friendly actionable error messages and proper error propagation.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/platform/onboarding/onboardingTourStore.ts` around lines 130 - 137, The
next-step entry flow must not continue to tracking after a non-abort onEnter
failure. Update the onEnter catch handling in the onboarding tour progression
logic to surface a user-friendly actionable error and stop or skip the tour, or
propagate the rejection to the caller; ensure trackTour('step_shown') is reached
only after successful entry setup.

Source: Coding guidelines

trackTour('step_shown')
}

Expand Down Expand Up @@ -169,13 +178,9 @@ export const useOnboardingTourStore = defineStore('onboardingTour', () => {
}

for (const [entryPath, trigger] of useTourTriggers()) {
watch(
trigger.autoOpen,
(visible) => {
if (visible) startTour(entryPath)
},
{ immediate: true }
)
whenever(trigger.autoOpen, () => startTour(entryPath), {
immediate: true
})
watch(trigger.holds, (holding) => {
if (!holding && activeTour.value === entryPath)
finish('skipped', { markSeen: false, skipReason: 'trigger_lost' })
Expand All @@ -192,19 +197,26 @@ export const useOnboardingTourStore = defineStore('onboardingTour', () => {
void settingStore.set(TOUR_SEEN_SETTING, [...seen, entryPath])
}

function startTour(entryPath: EntryPath, force = false) {
if (steps.value.length) return
if (!force && hasSeenTour(entryPath)) return
const resolved = resolveSteps(TOURS[entryPath], targetMounted)
if (!resolved.length) return
function begin(entryPath: EntryPath): boolean {
if (steps.value.length) return false
const definition = TOURS[entryPath]
const built = Array.isArray(definition) ? definition : definition()
const resolved = resolveSteps(built, targetMounted)
if (!resolved.length) return false
steps.value = resolved
activeTour.value = entryPath
trackTour('started')
void showStep(0)
return true
}

function startTour(entryPath: EntryPath): boolean {
if (hasSeenTour(entryPath)) return false
return begin(entryPath)
}

function replayTour(entryPath: EntryPath) {
startTour(entryPath, true)
begin(entryPath)
}

return {
Expand All @@ -219,6 +231,7 @@ export const useOnboardingTourStore = defineStore('onboardingTour', () => {
countedStepIdx,
countedStepsTotal,
waitingForTarget,
startTour,
replayTour,
next,
back,
Expand Down
5 changes: 4 additions & 1 deletion src/platform/onboarding/onboardingTours.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,11 @@ export interface CoachStep {
/** Renders the landing dialog instead of a spotlight. */
landing?: boolean
image?: string
onEnter?: (signal: AbortSignal) => void | Promise<void>
}

export type TourDefinition = CoachStep[] | (() => CoachStep[])

/**
* Fixes the running step set (and so the step count) at tour start: drops steps
* whose own target isn't mounted, keeping targetless and deferred steps.
Expand All @@ -55,7 +58,7 @@ export function resolveSteps(
)
}

export const TOURS: Record<EntryPath, CoachStep[]> = {
export const TOURS: Record<EntryPath, TourDefinition> = {
appMode: [
{
name: 'landing',
Expand Down
Loading