Welcome Tour
Package docs status
Section titled “Package docs status”This page is generated from public package documentation in capell-4/packages and the package manifest checked into the source repository.
| Field | Value |
|---|---|
| Composer package | capell-app/welcome-tour |
| Package slug | welcome-tour |
| Product group | Capell Foundation |
| Tier | free |
| Bundle | foundation |
| Runtime contexts | admin |
| Capell version | ^4.0 |
| Source repository | capell-app/packages |
| Source path | packages/welcome-tour |
| Docs source | packages/welcome-tour/docs |
| Manifest | capell.json |
What This Plugin Adds
Section titled “What This Plugin Adds”Welcome Tour is an Available, Schema-owning Capell package in the Capell Foundation product group. It ships as capell-app/welcome-tour and extends these surfaces: admin.
Configurable Filament onboarding tours and per-user welcome flow for the Capell admin panel.
After install, admins get package-owned management or reporting surfaces inside Capell.
Status details:
- Status: Available
- Tier: free
- Bundle: foundation
- Composer package:
capell-app/welcome-tour - Namespace:
Capell\WelcomeTour - Theme key: not applicable
Why It Matters
Section titled “Why It Matters”For developers: The package gives developers package-owned service providers, Actions, Data objects, Filament classes, and Blade views instead of pushing this behaviour into core or application code.
For teams: Guided, in-product onboarding for Capell Admin - configurable multi-step tours that introduce new editors to sites, pages, media, and settings, with per-user dismiss and resume.
Screens And Workflow
Section titled “Screens And Workflow”Screenshot contract: docs/screenshots.json.
- Admin dashboard rendered through WelcomeTourDashboard (admin, required).
- Welcome tour overlay showing the first configured onboarding step (admin, required).
- Welcome tour settings group with enabled toggle and step repeater (admin, required).
- User edit form with Show welcome tour toggle (admin, required).
Technical Shape
Section titled “Technical Shape”- Service providers:
Capell\WelcomeTour\Providers\WelcomeTourServiceProvider. - Config files:
packages/welcome-tour/config/capell-welcome-tour.php. - Migrations:
packages/welcome-tour/database/migrations/2026_06_04_000001_create_welcome_tour_user_states_table.php. - Settings migrations:
packages/welcome-tour/database/settings/2026_05_10_190836_01_add_welcome_tour_settings.php. - Settings classes:
WelcomeTourSettings. - Filament classes:
HasContextualWelcomeTour,WelcomeTourPanelExtender,WelcomeTourDashboard,WelcomeTourSettingsPage,WelcomeTourSettingsSchema,WelcomeTourChecklistFilamentWidget. - Events:
WelcomeTourCompleted,WelcomeTourRestarted,WelcomeTourSnoozed,WelcomeTourStarted,WelcomeTourStepCompleted. - Actions:
BuildWelcomeTourChecklistAction,CanShowWelcomeTourStepAction,ResolveWelcomeTourEnabledAction,CanShowWelcomeTourAction,GetUserWelcomeTourStateAction,RecordWelcomeTourStepAction,ResetUserWelcomeTourAction,ResolveWelcomeTourStepsForUserAction,SetUserWelcomeTourPreferenceAction,SnoozeUserWelcomeTourAction. - Data objects:
WelcomeTourChecklistItemData,WelcomeTourUserStateData. - Manifest contributions:
dashboard-widget: Capell\WelcomeTour\Manifest\WelcomeTourChecklistWidgetContribution,health-check: Capell\WelcomeTour\Manifest\WelcomeTourHealthContribution,setting: Capell\WelcomeTour\Manifest\WelcomeTourSettingsContribution. - Health checks:
Capell\WelcomeTour\Health\WelcomeTourHealthCheck. - Blade views:
packages/welcome-tour/resources/views/filament/widgets/welcome-tour-checklist.blade.php. - Cache tags:
welcome-tour.
Data Model
Section titled “Data Model”- Required tables:
welcome_tour_user_states. - Migration files:
2026_06_04_000001_create_welcome_tour_user_states_table.php. - Migration impact: run host migrations through the package install flow before opening package surfaces.
- Deletion/retention behaviour: Docs gap unless the package has an explicit pruning command, retention setting, or tested cascade path.
Install Impact
Section titled “Install Impact”- Admin navigation: adds package-owned Filament classes when registered.
- Permissions: none declared in
capell.json. - Public routes: none detected in package route files.
- Database changes: package migrations are declared.
- Settings:
Capell\WelcomeTour\Settings\WelcomeTourSettings. - Queues or schedules: none detected in standard package paths.
- Cache tags:
welcome-tour. - Commands: none declared.
Common Pitfalls
Section titled “Common Pitfalls”- Run migrations before opening package resources or public routes.
- Configure package settings before testing production-like workflows.
- Keep
composer.json,composer.local.json,capell.json, docs, screenshots, and tests aligned when the package surface changes.
Troubleshooting
Section titled “Troubleshooting”| Symptom | Likely cause | Check | Fix |
|---|---|---|---|
| Package surface is missing after install | Provider or manifest is not loaded | Confirm capell.json, package composer.json, and provider registration | Reinstall the package, refresh Composer autoload, and clear host caches |
| Admin screen or command fails on missing table | Package migrations have not run | Check the tables listed in Data Model | Run host migrations and rerun the focused package test |
Quick Start
Section titled “Quick Start”- Install the package:
composer require capell-app/welcome-tour. - Run the required setup:
php artisan migrate. - Open the related Capell admin surface and verify Welcome Tour appears.
Next Steps
Section titled “Next Steps”- Package docs
- Overview
- Screenshot contract
- Marketplace assets
- Capell content language plan
- Capell documentation design system
- Capell and package ERD notes
- Focused tests:
vendor/bin/pest packages/welcome-tour/tests --configuration=phpunit.xml.