Welcome Tour

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

Optional Filament welcome tour for Capell Admin.

At A Glance

• Package: capell-app/welcome-tour
• Namespace: Capell\WelcomeTour\
• Surfaces: Filament admin
• Service providers: packages/welcome-tour/src/Providers/WelcomeTourServiceProvider.php
• Capell dependencies: capell-app/admin
• Third-party dependencies: jibaymcs/filament-tour, laravel/framework, lorisleiva/laravel-actions, spatie/laravel-package-tools, spatie/laravel-settings

Why It Helps Your Capell Workflow

• Adds optional guided onboarding for Capell Admin so new users can learn the panel from inside the product.
• Helps owners introduce editors to key admin workflows without maintaining a separate onboarding checklist.
• Gives developers configurable tour steps and settings while keeping the tour optional for host apps.

Best Used With

• Translation Manager
• Diagnostics
• Notes

What It Adds

• Optional Filament welcome tour for Capell Admin.
• Package settings for controlling tour availability.
• A user edit form bridge for per-user tour state when the host user table supports it.

Code Map

Area	Path	Purpose
Actions	packages/welcome-tour/src/Actions	Domain operations. Test these directly where possible.
Data	packages/welcome-tour/src/Data	Structured payloads, form state, view models, and integration data.
Filament	packages/welcome-tour/src/Filament	Admin resources, pages, widgets, and settings UI.
Providers	packages/welcome-tour/src/Providers	Registration, extension hooks, routes, migrations, and resources.
Resources	packages/welcome-tour/resources	Views, translations, assets, and package resources.
Config	packages/welcome-tour/config	Package configuration and publishable config.
Database	packages/welcome-tour/database	Migrations, seeders, and settings migrations.
Tests	packages/welcome-tour/tests	Package-level Pest coverage.

Admin Surface

• Pages: WelcomeTourDashboard.
• Settings page: WelcomeTourSettingsPage at /admin/extensions/welcome-tour/settings.
• User edit form bridge: welcome_tour_enabled, when the host users table has dismissed_hints.

Data And Persistence

• Config: packages/welcome-tour/config/capell-welcome-tour.php.
• Data objects live in src/Data/; use them for payloads, form state, and view models.

Extension Points

• Register Capell extension points, routes, migrations, settings, render hooks, and resources from service providers.

Install And Setup

• Install with composer require capell-app/welcome-tour in the host Capell application.
• In this repository, verify package changes with vendor/bin/pest; do not use php artisan.
• In a disposable host app, publish and run the package settings migration before opening the settings page.

Docs

• docs index
• overview.md
• screenshots.json
• steps-and-settings.md

Testing

Run package tests from the repository root:

vendor/bin/pest packages/welcome-tour/tests --configuration=phpunit.xml

Maintenance Notes

• Put behaviour changes in src/Actions/; UI classes, commands, and controllers should call actions instead of owning domain logic.
• Use package Data classes at boundaries instead of passing anonymous arrays between layers.
• Keep package settings out of the global Settings page; extension settings should live on the package settings page.