Skip to main content
Agent skill

Add Onboarding Tour

Add a first-run guided tour, product walkthrough, coachmarks, or empty-state mock/example data to a Lightdash frontend feature. Use when the user wants to onboard users to a page, add a "Take the tour" flow, explain an unfamiliar UI, or show sample data on an empty page.

Get started

Get the complete skill folder, including its scripts and reference files.

When to use this skill

Use Add Onboarding Tour when an AI agent needs a reusable SKILL.md workflow for this job: Add a first-run guided tour, product walkthrough, coachmarks, or empty-state mock/example data to a Lightdash frontend feature. Use when the user wants to onboard users to a page, add a "Take the tour" flow, explain an unfamiliar UI, or show sample data on an empty page.

When not to use it

Skip Add Onboarding Tour when the task is outside the creativity category, or when a more specific skill in this directory already covers the same workflow with clearer triggers.

How to install

Where will you use it?

Install scope
Claude Code folder setup
mkdir -p ~/.claude/skills/add-onboarding-tour
# Save SKILL.md to ~/.claude/skills/add-onboarding-tour/SKILL.md
  1. Claude Code personal install: place the skill and its bundled files at ~/.claude/skills/add-onboarding-tour/SKILL.md. For a shared project, commit the folder at .claude/skills/add-onboarding-tour/ instead.
  2. Current Claude Code detects SKILL.md changes in watched directories during the session. If you just created a top-level skills directory, run /reload-skills. Check that the skill is listed before testing its trigger.
  3. For Claude chat or Cowork in the Desktop app, manage uploaded skills in Customize > Skills; copying files into a local Claude Code folder is not a Desktop install. Other agents may use different install locations.

Full install guide for Claude, Cursor, and Codex →

Try a starter prompt

After installing the skill, paste this starter prompt into your agent to verify it triggers on a small task.

Starter prompt
Use the Add Onboarding Tour skill for this task: Use Add Onboarding Tour when this documented workflow matches the task. Confirm any required inputs or files before making changes.

What supports this recommendation?

71/100 provisional content score. This measures documentation, practical detail and source signals. It is not a measured task success rate or a security certification.

Documentation
77/100
Practical detail
68/100
Source evidence
63/100
Source signals
72/100
Model compatibility evidence
  • claudeinferred

    The skill text mentions Claude or a closely associated term. This is keyword-derived compatibility; no hands-on model test is recorded.

  • chatgptuntested

    No model-specific signal or recorded compatibility test was found.

  • geminiuntested

    No model-specific signal or recorded compatibility test was found.

  • copilotuntested

    No model-specific signal or recorded compatibility test was found.

  • llamauntested

    No model-specific signal or recorded compatibility test was found.

  • perplexityuntested

    No model-specific signal or recorded compatibility test was found.

  • mistraluntested

    No model-specific signal or recorded compatibility test was found.

  • grokuntested

    No model-specific signal or recorded compatibility test was found.

Inferred compatibility is based on content signals. Check the app, its available tools and setup requirements before running a skill.

What this skill does

# Add an Onboarding Tour

A zero-dependency, centralised kit for first-run onboarding in `packages/frontend`. Three reusable pieces do the heavy lifting; each feature only supplies its own steps, copy, anchors, and (optionally) example data.

## Building blocks

| Piece | Path | Job | |---|---|---| | `useGuidedTour` | `src/hooks/useGuidedTour.ts` | localStorage seen-flag, first-visit auto-open, replay. Returns `{ isOpen, startTour, closeTour }`. | | `GuidedTour` | `src/components/common/GuidedTour` | Spotlight rendering. Dims the page, highlights a `data-tour` target, anchors a Next/Back/Skip card. `target: null` → centered card. | | `useOnboardingMock` | `src/hooks/useOnboardingMock.ts` | A react-query `select` that swaps real data for deterministic mock rows while a flag is on. |

**Reference implementation:** the Reviews page — `src/ee/features/aiCopilot/components/Admin/settings/AiReviewsSettingsPage.tsx` (wiring), `AiAgentAdminReviewItemsTable.tsx` (mock rows), and `Admin/onboarding/` (the content). Read these first — copying them is the fastest path.

## Where content lives

**Kit = global, content = per-feature.** The three building blocks above are shared. Everything specific to one feature — its steps, copy, sample rows, and any onboarding-only visuals — goes in a co-located `onboarding/` folder next to the feature, with the same fixed layout every time:

``` <feature-dir>/onboarding/ index.ts public surface (re-exports) steps.tsx TOUR_STEPS: GuidedTourStep[] (all the step copy) exampleData.ts EXAMPLE_*, isExample*() (only if the feature shows mock rows) <Visual>.tsx onboarding-only visuals, e.g. a diagram (+ .module.css) ```

The feature imports from `./onboarding`. Do **not** put feature content in a global folder, and do **not** inline steps or mock data in the page/table — keep components about rendering. Only re-export from `index.ts` what's consumed outside the folder (`ts-unused-exports` is enforced).

## Recipe

1. **Wire the tour state** in the feature page: ```tsx const { isOpen, startTour, closeTour } = useGuidedTour({ storageKey: 'ld.<feature>.tour.v1', }); ```

2. **Define steps** in `onboarding/steps.tsx` as a module constant (they're static — no `useMemo` needed). Each `target` is a CSS selector resolved when the step is reached, or `null` for a centered explainer: ```tsx export const TOUR_STEPS: GuidedTourStep[] = [ { target: '[data-tour="<feature>-intro"]', title: '…', body: '…' }, { target: '[data-tour="<feature>-row"]', title: '…', body: '…' }, { target: null, title: '…', body: <SomeDiagram /> }, // centered ]; ``` The page imports `{ TOUR_STEPS }` from `./onboarding` and passes it to `<GuidedTour>`.

3. **Add `data-tour` anchors** to the elements each step points at. For a **table row**, add it in the row props so the whole row is spotlit: ```tsx mantineTableBodyRowProps: ({ row }) => row.index === 0 ? { 'data-tour': '<feature>-row' } : {}, ```

4. **Render** the tour and a replay button: ```tsx <Button variant="subtle" leftSection={<MantineIcon icon={IconRoute} />} onClick={startTour}> Take the tour </Button> <GuidedTour steps={steps} opened={isOpen} onClose={closeTour} /> ```

5. **(Optional) Deterministic example data** so a tour on an empty (or any) page always highlights the same rows. Put stable, clearly-labelled mock rows and the `isExample` helper in `onboarding/exampleData.ts`, and inject them via `select` while the tour is open: ```tsx const select = useOnboardingMock(EXAMPLE_ROWS, isOpen); const { data } = useThings(args, { select }); // hook must forward `select` to useQuery ``` Render example rows muted and inert (disabled actions, no navigation); mark them with an "Example" badge. Gate interactivity off a sentinel id (e.g. `id.startsWith('example:')`).

## Conventions

- **Zero dependencies.** No joyride/driver/intro.js. The spotlight is a `box-shadow: 0 0 0 9999px` dim — already handled by `GuidedTour`. - **storageKey:** `ld.<feature>.tour.v<n>`. Bump the version to re-show the tour after a redesign. - **Copy:** warm, natural, straight to the point. **No em dashes, no arrows.** Short titles. - **Styling:** follow `frontend-style-guide` — no `style` prop (pass runtime geometry via `__vars`), CSS modules, theme tokens / `ldGray`/`ldDark`. - **Mock rows must never look or act real:** muted, "Example" badge, disabled actions.

## Gotchas

- **Targets that render late** (data still loading): handled — `GuidedTour` polls for each step's element and shows a centered card until it appears. Do **not** filter steps at open time; that drops steps whose targets haven't rendered yet. - **Determinism:** tie mock data to `isOpen` (tour running), not to emptiness, if you want the tour to highlight the same rows every run. Closing the tour flips back to real data. - **`select` passthrough:** the data hook must accept and forward a `select` option to `useQuery` (see `useAiAgentAdminReviewItems`). Add it if missing.

Intended uses

  • Use Add Onboarding Tour when this documented workflow matches the task.

Implementation notes

  • Review the source instructions and adapt inputs before running the workflow.

Try it, then tell us how it went

A copied prompt does not tell us whether the task worked. Report your result after checking the output. We collect your tool and outcome, never your files or prompt.