From 531fca30bda6c2f2fc21da5427eb47bb3e8a375b Mon Sep 17 00:00:00 2001 From: Dan Harrin Date: Sat, 12 Apr 2025 13:09:27 +0100 Subject: [PATCH] docs --- docs/11-plugins/01-getting-started.md | 6 +++--- packages/notifications/docs/03-broadcast-notifications.md | 2 -- packages/spatie-laravel-media-library-plugin/README.md | 2 -- packages/spatie-laravel-tags-plugin/README.md | 2 -- packages/widgets/docs/04-tables.md | 2 +- 5 files changed, 4 insertions(+), 10 deletions(-) diff --git a/docs/11-plugins/01-getting-started.md b/docs/11-plugins/01-getting-started.md index 8011ded939..3c7b9e0aa0 100644 --- a/docs/11-plugins/01-getting-started.md +++ b/docs/11-plugins/01-getting-started.md @@ -8,12 +8,12 @@ While Filament comes with virtually any tool you'll need to build great apps, so Before we dive in, it's important to understand the different contexts in which plugins can be used. There are two main contexts: -1. **Panel Plugins**: These are plugins that are used with [Panel Builders](../panels/installation). They are typically used only to add functionality when used inside a Panel or as a complete Panel in and of itself. Examples of this are: +1. **Panel Plugins**: These are plugins that are used with [Panel Builders](../introduction/installation). They are typically used only to add functionality when used inside a Panel or as a complete Panel in and of itself. Examples of this are: 1. A plugin that adds specific functionality to the dashboard in the form of Widgets. 2. A plugin that adds a set of Resources / functionality to an app like a Blog or User Management feature. 2. **Standalone Plugins**: These are plugins that are used in any context outside a Panel Builder. Examples of this are: - 1. A plugin that adds custom fields to be used with the [Form Builders](..//forms/installation/). - 2. A plugin that adds custom columns or filters to the [Table Builders](..//tables/installation/). + 1. A plugin that adds custom fields to be used with the [Form Builders](../forms/installation/). + 2. A plugin that adds custom columns or filters to the [Table Builders](../tables/installation/). Although these are two different mental contexts to keep in mind when building plugins, they can be used together inside the same plugin. They do not have to be mutually exclusive. diff --git a/packages/notifications/docs/03-broadcast-notifications.md b/packages/notifications/docs/03-broadcast-notifications.md index f9efc19c3a..ccd2b4bb99 100644 --- a/packages/notifications/docs/03-broadcast-notifications.md +++ b/packages/notifications/docs/03-broadcast-notifications.md @@ -4,8 +4,6 @@ title: Broadcast notifications ## Introduction -> To start, make sure the package is [installed](installation) - `@livewire('notifications')` should be in your Blade layout somewhere. - By default, Filament will send flash notifications via the Laravel session. However, you may wish that your notifications are "broadcast" to a user in real-time, instead. This could be used to send a temporary success notification from a queued job after it has finished processing. We have a native integration with [Laravel Echo](https://laravel.com/docs/broadcasting#client-side-installation). Make sure Echo is installed, as well as a [server-side websockets integration](https://laravel.com/docs/broadcasting#server-side-installation) like Pusher. diff --git a/packages/spatie-laravel-media-library-plugin/README.md b/packages/spatie-laravel-media-library-plugin/README.md index 84d5b6e0c1..f267dc4f12 100644 --- a/packages/spatie-laravel-media-library-plugin/README.md +++ b/packages/spatie-laravel-media-library-plugin/README.md @@ -36,8 +36,6 @@ SpatieMediaLibraryFileUpload::make('avatar') The media library file upload supports all the customization options of the [original file upload component](https://filamentphp.com/docs/forms/fields/file-upload). -> The field will automatically load and save its uploads to your model. To set this functionality up, **you must also follow the instructions set out in the [setting a form model](https://filamentphp.com/docs/forms/adding-a-form-to-a-livewire-component#setting-a-form-model) section**. If you're using a [panel](../panels), you can skip this step. - ### Passing a collection Optionally, you may pass a [`collection()`](https://spatie.be/docs/laravel-medialibrary/working-with-media-collections/simple-media-collections) allows you to group files into categories: diff --git a/packages/spatie-laravel-tags-plugin/README.md b/packages/spatie-laravel-tags-plugin/README.md index f663c7005b..6d8a661f9d 100644 --- a/packages/spatie-laravel-tags-plugin/README.md +++ b/packages/spatie-laravel-tags-plugin/README.md @@ -36,8 +36,6 @@ use Filament\Forms\Components\SpatieTagsInput; SpatieTagsInput::make('tags') ``` -> The field will automatically load and save its tags to your model. To set this functionality up, **you must also follow the instructions set out in the [field relationships](https://filamentphp.com/docs/forms/adding-a-form-to-a-livewire-component#setting-a-form-model) section**. If you're using the [Panel Builder](../panels), you can skip this step. - Optionally, you may pass a [`type()`](https://spatie.be/docs/laravel-tags/advanced-usage/using-types) allows you to group tags into collections: ```php diff --git a/packages/widgets/docs/04-tables.md b/packages/widgets/docs/04-tables.md index 2d95a1a994..64448e0cdf 100644 --- a/packages/widgets/docs/04-tables.md +++ b/packages/widgets/docs/04-tables.md @@ -2,6 +2,6 @@ title: Table widgets --- -When using the [Panel Builder](../panels), you can use table widgets. These use the [table builder](../tables). You can find out how to create them [here](../panels/dashboard#table-widgets). +When inside a panel, you can use table widgets. These use the [table builder](../tables). You can find out how to create them [here](../panels/dashboard#table-widgets). If you're not using the Panel Builder, there's no need to use a "widget" to render a table. You can simply [add a table to a Livewire component](../tables/adding-a-table-to-a-livewire-component), which does not provide any specific benefits over a widget.