add-onboarding-tour

Adds guided tours, coachmarks, and example data to Lightdash frontend features.

6.1k|768|Updated Mar 19, 2021
One-click install
npx skills add https://github.com/lightdash/lightdash --skill add-onboarding-tour
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-onboarding-tour
Source: https://github.com/lightdash/lightdash/tree/main/.claude/skills/add-onboarding-tour
Command: npx skills add https://github.com/lightdash/lightdash --skill add-onboarding-tour

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

New users landing on an unfamiliar Lightdash page often lack guidance on what the feature does or how to use it, and empty pages give them nothing to explore. This Skill provides a repeatable recipe for adding first-run guided tours, spotlight coachmarks, and deterministic example data to any frontend feature without pulling in third-party tour libraries.

Core Features & Use Cases

  • Guided tour wiring: Uses the shared useGuidedTour hook and GuidedTour spotlight component to auto-open a step-by-step walkthrough on first visit, with localStorage seen-flags and a replay button.
  • Co-located onboarding content: Enforces a fixed onboarding/ folder layout per feature (steps, example data, visuals) so tour copy and mock rows stay out of page components.
  • Deterministic example data: Injects clearly-labelled mock rows via a react-query select while the tour runs, so empty pages always highlight the same content.
  • Use Case: When shipping a new admin settings page, use this Skill to add a "Take the tour" flow that spotlights key UI elements and shows sample rows, so first-time users understand the page immediately.

Quick Start

Add a first-run guided tour with example data to my new Lightdash frontend feature page following the onboarding kit conventions.

Frequently Asked Questions about add-onboarding-tour

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a guided tour to a React page?

Wire the useGuidedTour hook with a versioned localStorage key in your page component, define TOUR_STEPS in an onboarding/steps.tsx file, add data-tour attributes to target elements, and render the GuidedTour component with a replay button.

How do I show mock data on an empty page during onboarding?

Define stable example rows and an isExample helper in onboarding/exampleData.ts, then inject them through the useOnboardingMock react-query select while the tour is open. Render example rows muted with an Example badge and disabled actions.

Does this onboarding approach require libraries like react-joyride or driver.js?

No, the kit is zero-dependency. The GuidedTour component implements the spotlight effect with a box-shadow dim, so no third-party tour libraries like joyride, driver, or intro.js are needed.

Why does my tour step not highlight its target element?

Targets that render late, such as rows still loading, are handled automatically because GuidedTour polls for each step's element and shows a centered card until it appears. Do not filter steps at open time, as that drops steps whose targets have not rendered yet.

How do I re-show a tour to users after a page redesign?

Bump the version number in the storageKey, which follows the pattern ld.<feature>.tour.v<n>. A new version key means the old seen-flag no longer applies, so the tour auto-opens again on the next visit.