Help Guide

Help Guide provides contextual help and guidance throughout your Filament application, making it easier for users to understand and navigate your application.

Installation

You can install the package via composer:

composer require paper-leaf/help-guide

Important

If you have not set up a custom theme and are using Filament Panels follow the instructions in the Filament Docs first.

After setting up a custom theme add the plugin's views to your theme css file or your app's css file if using the standalone packages.

@source '../../../../vendor/paper-leaf/help-guide/resources/**/*.blade.php';

You can publish and run the migrations with:

php artisan vendor:publish --tag="help-guide-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="help-guide-config"

Optionally, you can publish the views using

php artisan vendor:publish --tag="help-guide-views"

Usage

Ensure you have ->default() set on your primary panel you are intalling this plugin on.

Register the plugin within your default panel's definition.

use PaperLeaf\HelpGuide\HelpGuidePlugin;

->plugin(
    HelpGuidePlugin::make()
)

The plugin can be customized in the following ways:

Ability to Manage the Guide

Set which users can access the "Manage Guide" section of the panel. Only users who have the specificied permission will see any edit functionality within the Help Guide.

->plugin(
    HelpGuidePlugin::make()
        ->manageGuidePermission('gate_name')
)

Available Permissions

Define the list of permissions that users can have within the system. These need to be tied to Gates within Laravel. Then these permissions can be assigned to help pages, and only users with that permission can view that page.

->plugin(
    HelpGuidePlugin::make()
        ->availablePermissions(fn() => SystemPermission::toArray())
)

Login URL

Specify the login URL of your main dashboard so unauthenticated users accessing the Help Guide are redirected to the correct login page.

->plugin(
    HelpGuidePlugin::make()
        ->loginUrl('/custom-url')
)

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Sarah Tinga
• All Contributors

License

The MIT License (MIT). Please see License File for more information.