Skip to content

Commit

Permalink
update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
atmonshi committed Aug 19, 2023
1 parent 3f614ec commit d0b5c4d
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 30 deletions.
20 changes: 15 additions & 5 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'),
```
2 changes: 1 addition & 1 deletion docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
24 changes: 8 additions & 16 deletions docs/filament.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,26 @@
<!-- TOC -->
* [Zeus Wind](#zeus-wind)
* [Features:](#features)
* [Screenshots:](#screenshots)
* [More Details](#more-details)
<!-- TOC -->

# 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:**
Expand Down
8 changes: 2 additions & 6 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 0 additions & 2 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d0b5c4d

Please sign in to comment.