From 3337aa61aef06a6a860af80786e154e3953e00fa Mon Sep 17 00:00:00 2001 From: phuong Date: Thu, 10 Aug 2023 00:57:17 +0700 Subject: [PATCH 1/2] Improve documentation: grammar/spelling/punctuation correction, proper capitalization --- README.md | 10 +++++----- packages/actions/docs/02-overview.md | 4 ++-- packages/actions/docs/04-modals.md | 4 ++-- packages/actions/docs/05-grouping-actions.md | 2 +- ...dding-an-action-to-a-livewire-component.md | 2 +- packages/actions/docs/09-testing.md | 2 +- packages/actions/docs/10-upgrade-guide.md | 6 +++--- packages/forms/docs/02-getting-started.md | 6 +++--- packages/forms/docs/03-fields/03-select.md | 4 ++-- .../forms/docs/03-fields/06-checkbox-list.md | 4 ++-- packages/forms/docs/03-fields/07-radio.md | 4 ++-- .../docs/03-fields/08-date-time-picker.md | 2 +- .../forms/docs/03-fields/09-file-upload.md | 2 +- packages/forms/docs/03-fields/12-repeater.md | 2 +- .../forms/docs/03-fields/14-tags-input.md | 4 ++-- packages/forms/docs/04-layout/02-grid.md | 6 +++--- packages/forms/docs/05-validation.md | 14 ++++++------- packages/forms/docs/06-actions.md | 2 +- packages/forms/docs/07-advanced.md | 10 +++++----- ...8-adding-a-form-to-a-livewire-component.md | 10 +++++----- packages/forms/docs/09-testing.md | 8 ++++---- packages/forms/docs/10-upgrade-guide.md | 10 +++++----- packages/infolists/docs/02-getting-started.md | 6 +++--- packages/infolists/docs/03-entries/02-text.md | 2 +- .../infolists/docs/03-entries/04-image.md | 4 ++-- .../docs/04-layout/01-getting-started.md | 2 +- packages/infolists/docs/04-layout/02-grid.md | 4 ++-- packages/infolists/docs/05-actions.md | 8 ++++---- .../docs/02-sending-notifications.md | 4 ++-- .../docs/03-database-notifications.md | 4 ++-- .../docs/05-customizing-notifications.md | 2 +- .../notifications/docs/07-upgrade-guide.md | 4 ++-- packages/panels/docs/01-installation.md | 2 +- packages/panels/docs/02-getting-started.md | 12 +++++------ .../docs/03-resources/01-getting-started.md | 2 +- .../docs/03-resources/02-listing-records.md | 2 +- .../docs/03-resources/03-creating-records.md | 14 ++++++------- .../docs/03-resources/04-editing-records.md | 14 ++++++------- .../docs/03-resources/05-viewing-records.md | 6 +++--- .../docs/03-resources/06-deleting-records.md | 4 ++-- .../docs/03-resources/07-relation-managers.md | 14 ++++++------- .../docs/03-resources/08-global-search.md | 4 ++-- packages/panels/docs/04-pages.md | 6 +++--- packages/panels/docs/05-dashboard.md | 4 ++-- packages/panels/docs/07-notifications.md | 2 +- packages/panels/docs/08-users.md | 2 +- packages/panels/docs/09-configuration.md | 2 +- packages/panels/docs/10-tenancy.md | 4 ++-- packages/panels/docs/11-themes.md | 2 +- packages/panels/docs/14-upgrade-guide.md | 16 +++++++-------- .../README.md | 2 +- .../spatie-laravel-settings-plugin/README.md | 2 +- packages/spatie-laravel-tags-plugin/README.md | 2 +- packages/support/docs/02-assets.md | 10 +++++----- packages/support/docs/06-render-hooks.md | 2 +- packages/support/docs/07-enums.md | 16 +++++++-------- .../docs/08-plugins/01-getting-started.md | 10 +++++----- .../08-plugins/02-build-a-panel-plugin.md | 20 +++++++++---------- .../03-build-a-standalone-plugin.md | 16 +++++++-------- .../09-blade-components/02-input-wrapper.md | 2 +- .../docs/09-blade-components/02-modal.md | 2 +- .../docs/09-blade-components/02-tabs.md | 2 +- packages/tables/docs/02-getting-started.md | 18 ++++++++--------- .../docs/03-columns/01-getting-started.md | 2 +- packages/tables/docs/03-columns/02-text.md | 4 ++-- packages/tables/docs/03-columns/04-image.md | 4 ++-- packages/tables/docs/04-filters.md | 6 +++--- packages/tables/docs/05-actions.md | 8 ++++---- packages/tables/docs/06-layout.md | 2 +- packages/tables/docs/07-summaries.md | 2 +- packages/tables/docs/09-empty-state.md | 2 +- packages/tables/docs/10-advanced.md | 2 +- ...-adding-a-table-to-a-livewire-component.md | 6 +++--- packages/tables/docs/12-testing.md | 12 +++++------ packages/tables/docs/13-upgrade-guide.md | 4 ++-- packages/widgets/docs/02-stats-overview.md | 4 ++-- packages/widgets/docs/03-charts.md | 4 ++-- 77 files changed, 218 insertions(+), 218 deletions(-) diff --git a/README.md b/README.md index c71f66c8de..28668fa5c9 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Filament is a collection of full-stack components for accelerated Laravel develo ### Panel Builder • [Documentation](https://filamentphp.com/docs/panels) • [Demo](https://demo.filamentphp.com) -The panel builder is the foundation of Filament. Combining all the packages together, it lets you quickly build Laravel admin panels, customer-facing apps, Software-as-a-Service platforms, and more. Filament makes custom CRUD-driven interfaces feel like a breeze to build and deploy. +The Panel Builder is the foundation of Filament. Combining all the packages together, it lets you quickly build Laravel admin panels, customer-facing apps, Software-as-a-Service platforms, and more. Filament makes custom CRUD-driven interfaces feel like a breeze to build and deploy. ```bash composer require filament/filament @@ -23,7 +23,7 @@ composer require filament/filament ### Form Builder • [Documentation](https://filamentphp.com/docs/forms) -Rendering interactive forms in a Livewire component has never been easier than with our form builder. Easily build stunning forms with over 25 components out of the box. It's also fully extensible, so you can add your own custom fields and actions. As well as the panel builder, it is seamlessly integrated into action modals, and is used by the table builder to filter rows. +Rendering interactive forms in a Livewire component has never been easier than with our Form Builder. Easily build stunning forms with over 25 components out of the box. It's also fully extensible, so you can add your own custom fields and actions. As well as the Panel Builder, it is seamlessly integrated into action modals, and is used by the Table Builder to filter rows. ```bash composer require filament/forms @@ -47,7 +47,7 @@ composer require filament/notifications ### Actions • [Documentation](https://filamentphp.com/docs/actions) -Actions are buttons that can open modals. They are a very versatile component of many interfaces, avoiding the need for the user to navigate away from the page to complete a task. From confirming a destructive action, to editing an Eloquent record, to importing data from an uploaded CSV file, action modals are a great way to keep the user in the flow of the application. Modals are built upon our form builder, so they are built upon the same principles of flexibility and extensibility. Modals can be added to any Livewire component with just a few lines of code, and no HTML or JavaScript. +Actions are buttons that can open modals. They are a very versatile component of many interfaces, avoiding the need for the user to navigate away from the page to complete a task. From confirming a destructive action, to editing an Eloquent record, to importing data from an uploaded CSV file, action modals are a great way to keep the user in the flow of the application. Modals are built upon our Form Builder, so they are built upon the same principles of flexibility and extensibility. Modals can be added to any Livewire component with just a few lines of code, and no HTML or JavaScript. ```bash composer require filament/actions @@ -55,7 +55,7 @@ composer require filament/actions ### Infolists • [Documentation](https://filamentphp.com/docs/infolists) -Infolists are a great way to display read-only information to users about a particular record. They have a fully flexible layout, and can be extended with custom components. They are also seamlessly integrated with the panel builder, so you can easily add them to your panel resources. +Infolists are a great way to display read-only information to users about a particular record. They have a fully flexible layout, and can be extended with custom components. They are also seamlessly integrated with the Panel Builder, so you can easily add them to your panel resources. ```bash composer require filament/infolists @@ -63,7 +63,7 @@ composer require filament/infolists ### Widgets • [Documentation](https://filamentphp.com/docs/widgets) -Filament's collection of widgets are built upon Livewire's core principles of real-time reactivity with the server. Combining many widgets lets you quickly build a dashboard for your application, complete with charts and stats, which are able to update live without refreshing the page. They are also seamlessly integrated with any page in the panel builder. +Filament's collection of widgets are built upon Livewire's core principles of real-time reactivity with the server. Combining many widgets lets you quickly build a dashboard for your application, complete with charts and stats, which are able to update live without refreshing the page. They are also seamlessly integrated with any page in the Panel Builder. ```bash composer require filament/widgets diff --git a/packages/actions/docs/02-overview.md b/packages/actions/docs/02-overview.md index 4aa4f651cc..3de5be852b 100644 --- a/packages/actions/docs/02-overview.md +++ b/packages/actions/docs/02-overview.md @@ -46,7 +46,7 @@ The entire look of the action's trigger button and the modal is customizable usi ## Types of action -The concept of "actions" is used throughout Filament in many contexts. Some contexts don't support opening modals from actions - they can only open a URL, call a public Livewire method, or dispatch a Livewire event. Additionally, different contexts use different action PHP classes, since they provide the developer context-aware data that is appropriate to that use-case. +The concept of "actions" is used throughout Filament in many contexts. Some contexts don't support opening modals from actions - they can only open a URL, call a public Livewire method, or dispatch a Livewire event. Additionally, different contexts use different action PHP classes since they provide the developer context-aware data that is appropriate to that use-case. ### Custom Livewire component actions @@ -96,7 +96,7 @@ If you're looking to add an action to a notification in your app, [visit this pa ### Global search result actions -In the panel builder, there is a [global search](../panels/resources/global-search) field that allows you to search all resources in your app from one place. When you click on a search result, it leads you to the resource page for that record. However, you may add additional actions below each global search result. For example, you may want both "Edit" and "View" options for a client search result, so the user can quickly edit their profile as well as view it in read-only mode. +In the Panel Builder, there is a [global search](../panels/resources/global-search) field that allows you to search all resources in your app from one place. When you click on a search result, it leads you to the resource page for that record. However, you may add additional actions below each global search result. For example, you may want both "Edit" and "View" options for a client search result, so the user can quickly edit their profile as well as view it in read-only mode. These actions use the `Filament\GlobalSearch\Actions\Action` class. They aren't able to open modals, but they can open a URL or dispatch a Livewire event. diff --git a/packages/actions/docs/04-modals.md b/packages/actions/docs/04-modals.md index a7460bee85..366afeaf97 100644 --- a/packages/actions/docs/04-modals.md +++ b/packages/actions/docs/04-modals.md @@ -73,7 +73,7 @@ Action::make('updateAuthor') ### Using a wizard as a modal form -You may create a [multi-step form wizard](../forms/layout/wizard) inside a modal. Instead of using a `form()`, define a `steps()` array and pass your `Step` objects: +You may create a [multistep form wizard](../forms/layout/wizard) inside a modal. Instead of using a `form()`, define a `steps()` array and pass your `Step` objects: ```php use Filament\Forms\Components\MarkdownEditor; @@ -476,7 +476,7 @@ Action::make('first') ]) ``` -In this example, if the `fourth` action is run, the `second` action is cancelled, but so is the `third` action since it is a child of `second`. The `first` action is not cancelled, however, since it is the parent of `second`. The `first` action's modal will remain open. +In this example, if the `fourth` action is run, the `second` action is canceled, but so is the `third` action since it is a child of `second`. The `first` action is not canceled, however, since it is the parent of `second`. The `first` action's modal will remain open. ## Closing the modal by clicking away diff --git a/packages/actions/docs/05-grouping-actions.md b/packages/actions/docs/05-grouping-actions.md index 4405aaf865..0c167d2a46 100644 --- a/packages/actions/docs/05-grouping-actions.md +++ b/packages/actions/docs/05-grouping-actions.md @@ -21,7 +21,7 @@ This page is about customizing the look of the group's trigger button and dropdo ## Customizing the group trigger style -The button which opens the dropdown may be customized in the same way as a normal action. [All of the methods available for trigger buttons](trigger-button) may be used to customize the group trigger button: +The button which opens the dropdown may be customized in the same way as a normal action. [All the methods available for trigger buttons](trigger-button) may be used to customize the group trigger button: ```php use Filament\Support\Enums\ActionSize; diff --git a/packages/actions/docs/06-adding-an-action-to-a-livewire-component.md b/packages/actions/docs/06-adding-an-action-to-a-livewire-component.md index 3ae48c41f2..50b2d96039 100644 --- a/packages/actions/docs/06-adding-an-action-to-a-livewire-component.md +++ b/packages/actions/docs/06-adding-an-action-to-a-livewire-component.md @@ -197,4 +197,4 @@ public function publishAction(): Action Now, when the first action is submitted, the second action will open in its place. The [arguments](#passing-action-arguments) that were originally passed to the first action get passed to the second action, so you can use them to persist data between requests. -If the first action is cancelled, the second one is not opened. If the second action is cancelled, the first one has already run and cannot be cancelled. +If the first action is canceled, the second one is not opened. If the second action is canceled, the first one has already run and cannot be cancelled. diff --git a/packages/actions/docs/09-testing.md b/packages/actions/docs/09-testing.md index 7d87c32d8a..982e5a829d 100644 --- a/packages/actions/docs/09-testing.md +++ b/packages/actions/docs/09-testing.md @@ -248,7 +248,7 @@ it('when enabled the send button has correct icon', function () { }); ``` -To ensure an action's button is displaying the right color, you can use `assertActionHasColor()` or `assertActionDoesNotHaveColor()`: +To ensure that an action's button is displaying the right color, you can use `assertActionHasColor()` or `assertActionDoesNotHaveColor()`: ```php use function Pest\Livewire\livewire; diff --git a/packages/actions/docs/10-upgrade-guide.md b/packages/actions/docs/10-upgrade-guide.md index b1a0f65f91..0d1d135c10 100644 --- a/packages/actions/docs/10-upgrade-guide.md +++ b/packages/actions/docs/10-upgrade-guide.md @@ -22,7 +22,7 @@ Since Livewire v3 is still in beta, set the `minimum-stability` in your `compose "minimum-stability": "dev", ``` -The easiest way to upgrade your app is to run the automated upgrade script. This script will automatically upgrade your application to the latest version of Filament and make changes to your code which handle most breaking changes. +The easiest way to upgrade your app is to run the automated upgrade script. This script will automatically upgrade your application to the latest version of Filament and make changes to your code, which handles most breaking changes. ```bash composer require filament/upgrade:"^3.0-stable" -W --dev @@ -34,7 +34,7 @@ Make sure to carefully follow the instructions, and review the changes made by t Finally, you must run `php artisan filament:install` to finalize the Filament v3 installation. This command must be run for all new Filament projects. -You can now `composer remove filament/upgrade` as you don't need it any more. +You can now `composer remove filament/upgrade` as you don't need it anymore. > Some plugins you're using may not be available in v3 just yet. You could temporarily remove them from your `composer.json` file until they've been upgraded, replace them with a similar plugins that are v3-compatible, wait for the plugins to be upgraded before upgrading your app, or even write PRs to help the authors upgrade them. @@ -46,7 +46,7 @@ Since Livewire v3 is still in beta, set the `minimum-stability` in your `compose "minimum-stability": "dev", ``` -### Low impact changes +### Low-impact changes #### Action execution with forms diff --git a/packages/forms/docs/02-getting-started.md b/packages/forms/docs/02-getting-started.md index 2dd4251b79..58488c17ce 100644 --- a/packages/forms/docs/02-getting-started.md +++ b/packages/forms/docs/02-getting-started.md @@ -15,7 +15,7 @@ All Filament forms have a "schema". This is an array, which contains [fields](fi Fields are the inputs that your user will fill their data into. For example, HTML's `` or `