From d0b5c4de433ada929c05f83848f4d146c8e59854 Mon Sep 17 00:00:00 2001 From: Ash Monsh Date: Sat, 19 Aug 2023 03:59:46 +0300 Subject: [PATCH] update the docs --- docs/configuration.md | 20 +++++++++++++++----- docs/customization.md | 2 +- docs/filament.md | 24 ++++++++---------------- docs/introduction.md | 8 ++------ docs/usage.md | 2 -- 5 files changed, 26 insertions(+), 30 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 0e4e683..52e8ad6 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -5,10 +5,20 @@ weight: 3 ## Configuration -to publish the config file run the command: +to configure the plugin Wind, you can pass the configuration to the plugin in `adminPanelProvider` -```bash -php artisan vendor:publish --tag=zeus-wind-config -``` +these all the available configuration, and their defaults values -you can pass `--force` option to force publishing the config file +```php +WindPlugin::make() + ->windPrefix('wind') + ->windMiddleware(['web']) + ->defaultDepartmentId(1) + ->defaultStatus('NEW') + ->departmentResource() + ->departmentModel(\LaraZeus\Wind\Models\Department::class) + ->letterModel(\LaraZeus\Wind\Models\Letter::class) + ->uploadDisk('public') + ->uploadDirectory('logos') + ->navigationGroupLabel('Wind'), +``` diff --git a/docs/customization.md b/docs/customization.md index 0f4d8d4..f8e2c95 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -3,7 +3,7 @@ title: Customization weight: 6 --- -to customize the layout, you can change the default layout in the config file +to customize the layout, you can change the default layout in the `zeus.php` config file ```php 'layout' => 'components.app', diff --git a/docs/filament.md b/docs/filament.md index 37e108d..8ca165e 100644 --- a/docs/filament.md +++ b/docs/filament.md @@ -1,34 +1,26 @@ - -* [Zeus Wind](#zeus-wind) - * [Features:](#features) - * [Screenshots:](#screenshots) - * [More Details](#more-details) - - # Zeus Wind Wind contact form for your website with easy to use dashboard, works as a plugin for Filament Admin Panel make it easier to customize it and match your branding. -## Features: +## Features -- ๐Ÿ”ฅ built with [TALL stack](https://tallstack.dev/) -- ๐Ÿ”ฅ using [filament](https://filamentadmin.com) as an admin panel - ๐Ÿ”ฅ optionally you can add categories to the contact form like 'sales','dev','report bug' etc. - ๐Ÿ”ฅ you can add logos for all categories. - ๐Ÿ”ฅ direct URL to contact on specific category. +- ๐Ÿ”ฅ Frontend scaffolding, highly customizable. -## Screenshots: +## Screenshots * **Contact form:** simple contact form allow your users to contact you - ![](https://larazeus.com/images/screenshots/wind/admin-1.png) - ![](https://larazeus.com/images/screenshots/wind/admin-2.png) - ![](https://larazeus.com/images/screenshots/wind/admin-3.png) +![](https://larazeus.com/images/screenshots/wind/admin-1.png) +![](https://larazeus.com/images/screenshots/wind/admin-2.png) +![](https://larazeus.com/images/screenshots/wind/admin-3.png) * **Departments:** optionally you can create departments to make it easy to manage the letters - ![](https://larazeus.com/images/screenshots/wind/frontend-1.png) - ![](https://larazeus.com/images/screenshots/wind/frontend-2.png) +![](https://larazeus.com/images/screenshots/wind/frontend-1.png) +![](https://larazeus.com/images/screenshots/wind/frontend-2.png) ## More Details **โœจ to learn more about Wind the form builder, please visit:** diff --git a/docs/introduction.md b/docs/introduction.md index 5fefe43..51c179f 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -7,23 +7,19 @@ weight: 1 Lara-zeus Wind, is a package provides a simple contact form manger, with the abilety to store the messages in the database, and you can reply to them from the dashboard. - -**[Demo](https://wind.larazeus.com) ยท [Source Code](https://github.com/lara-zeus/wind)** +**[Demo](https://wind.larazeus.com) ยท [Source Code](https://github.com/lara-zeus/wind) ยท [Discord](https://discord.com/channels/883083792112300104/943098344174141460)** ## features: ๐Ÿ”ฅ built with [TALL stack](https://tallstack.dev/) - ๐Ÿ”ฅ using [filament](https://filamentadmin.com) as an admin panel - ๐Ÿ”ฅ optionally you can add departments to the contact form like 'sales','dev','report bug' etc. - ๐Ÿ”ฅ you can add logos for all departments. - ๐Ÿ”ฅ direct URL to contact on specific department. ## Support available support channels: +* join our channel in discord [Discord](https://discord.com/channels/883083792112300104/943098344174141460) * open an issue on [GitHub](https://github.com/lara-zeus/wind/issues) * email us using the [contact center](https://still-code.com/contact-us/lara-zeus) diff --git a/docs/usage.md b/docs/usage.md index af2db52..b6e0c7d 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -7,8 +7,6 @@ weight: 4 after you finished installing `wind` all you have to do is visit the url `/admin` to manage the Letters, and `/contact-us` to access the contact form. -> you can configure the URL from the config file, - check the configuration section for more details if you don't have a user, or it's a fresh installation of laravel, you can use the command to create a new user