Skip to content
Capell CMS

Welcome Tour

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

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 ^1.0
Catalogue role extension
Release channel Labs
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.

Welcome Tour adds a contextual admin checklist with per-user step state, preferences, snoozing, and reset behavior. The checklist is exposed as a Filament dashboard widget.

Administrators see relevant setup steps on the dashboard and can complete, snooze, or reset their own tour state.

Evidence: src/Filament/Widgets/WelcomeTourChecklistFilamentWidget.php, src/Actions/BuildWelcomeTourChecklistAction.php, src/Support/ContextualWelcomeTourRegistry.php, tests/Feature/WelcomeTourTest.php, src/Filament/Extenders/WelcomeTourPanelExtender.php.

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: A contextual registry and focused Actions keep checklist composition separate from the Filament widget and persisted user state.

For teams: Teams can give each administrator a repeatable setup path without forcing every user through the same uninterrupted sequence.

Evidence: src/Support/ContextualWelcomeTourRegistry.php, src/Actions/BuildWelcomeTourChecklistAction.php, tests/Unit/WelcomeTourSchemaCoverageTest.php, src/Filament/Widgets/WelcomeTourChecklistFilamentWidget.php, tests/Feature/WelcomeTourTest.php, tests/Feature/WelcomeTourSettingsTest.php.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Admin dashboard with the Welcome Tour onboarding checklist Admin dashboard with the Welcome Tour onboarding checklist Welcome tour overlay showing the first configured onboarding step Welcome tour overlay showing the first configured onboarding step
  • Admin dashboard with the Welcome Tour onboarding checklist (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, WelcomeTourSettingsSchema, WelcomeTourChecklistFilamentWidget.
  • Events: WelcomeTourCompleted, WelcomeTourRestarted, WelcomeTourSnoozed, WelcomeTourStarted, WelcomeTourStepCompleted.
  • Actions: BuildWelcomeTourChecklistAction, CanShowWelcomeTourStepAction, ResolveWelcomeTourEnabledAction, AuthorizeWelcomeTourUserMutationAction, CanShowWelcomeTourAction, GetUserWelcomeTourStateAction, RecordWelcomeTourStepAction, ResetUserWelcomeTourAction, ResolveWelcomeTourStepsForUserAction, SetUserWelcomeTourPreferenceAction, SnoozeUserWelcomeTourAction.
  • Data objects: WelcomeTourChecklistItemData, WelcomeTourUserStateData.
  • Manifest action API: buildWelcomeTourChecklist: Capell\WelcomeTour\Actions\BuildWelcomeTourChecklistAction, canShowWelcomeTour: Capell\WelcomeTour\Actions\Users\CanShowWelcomeTourAction, canShowWelcomeTourStep: Capell\WelcomeTour\Actions\CanShowWelcomeTourStepAction, getUserWelcomeTourState: Capell\WelcomeTour\Actions\Users\GetUserWelcomeTourStateAction, recordWelcomeTourStep: Capell\WelcomeTour\Actions\Users\RecordWelcomeTourStepAction, resetUserWelcomeTour: Capell\WelcomeTour\Actions\Users\ResetUserWelcomeTourAction, resolveWelcomeTourEnabled: Capell\WelcomeTour\Actions\ResolveWelcomeTourEnabledAction, resolveWelcomeTourStepsForUser: Capell\WelcomeTour\Actions\Users\ResolveWelcomeTourStepsForUserAction, setUserWelcomeTourPreference: Capell\WelcomeTour\Actions\Users\SetUserWelcomeTourPreferenceAction, snoozeUserWelcomeTour: Capell\WelcomeTour\Actions\Users\SnoozeUserWelcomeTourAction.
  • 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.
  • Core record references in migrations: users via user_id.
  • 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: migrations and manifest contributions do not prove a cascade, pruning command, or timed retention policy.

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin.
  • Admin navigation: no admin page or resource contribution is declared.
  • Admin/editor extensions: dashboard-widget: WelcomeTourChecklistWidgetContribution.
  • Permissions: none declared in capell.json.
  • Public routes: none declared.
  • Database changes: package migrations are declared.
  • Config: config/capell-welcome-tour.php.
  • Settings: Capell\WelcomeTour\Settings\WelcomeTourSettings.
  • Queues or schedules: none declared.
  • Cache tags: welcome-tour.
  • Commands: none declared.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin.
  • Run migrations before opening package resources or public routes.
  • Review package configuration before production-like verification: config/capell-welcome-tour.php, Capell\WelcomeTour\Settings\WelcomeTourSettings.
  • Custom write integrations must preserve invalidation for welcome-tour cache tags.

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”
  1. Install the package: composer require capell-app/welcome-tour.
  2. Run the required setup: php artisan migrate.
  3. Open the Admin dashboard rendered through WelcomeTourDashboard and confirm the admin workflow loads.

Next Steps

Section titled “Next Steps”