Skip to content

Commit 890d9cd

Browse files
committed
working on guidelines
1 parent cdbaca0 commit 890d9cd

File tree

3 files changed

+18
-14
lines changed

3 files changed

+18
-14
lines changed

.ai/fluxui-free/core.blade.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
## Flux UI Free
2+
13
- This project is using the free edition of Flux UI. It has full access to the free components and variants, but does not have access to the Pro components.
24
- Flux UI is a component library for Livewire. Flux is a robust, hand-crafted, UI component library for your Livewire applications. It's built using Tailwind CSS and provides a set of components that are easy to use and customize.
35
- You should use Flux UI components when available.
@@ -8,7 +10,7 @@
810
<flux:button variant="primary"/>
911
</code-snippet>
1012

11-
## Available Components
13+
### Available Components
1214
This is correct as of Boost installation, but there may be additional components within the codebase.
1315

1416
<available-flux-components>

.ai/fluxui-pro/core.blade.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
## Flux UI Pro
2+
13
- This project is using the Pro version of Flux UI. It has full access to the free components and variants, as well as full access to the Pro components and variants.
24
- Flux UI is a component library for Livewire. Flux is a robust, hand-crafted, UI component library for your Livewire applications. It's built using Tailwind CSS and provides a set of components that are easy to use and customize.
35
- You should use Flux UI components when available.
@@ -8,7 +10,7 @@
810
<flux:button variant="primary"/>
911
</code-snippet>
1012

11-
## Available Components
13+
### Available Components
1214
This is correct as of Boost installation, but there may be additional components within the codebase.
1315

1416
<available-flux-components>

.ai/folio/core.blade.php

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,26 @@
1+
## Laravel Folio
12

2-
- Laravel Folio is a file based router. With Laravel Folio, a new route is creatted for every Blade file within the correct directory. i.e. `Pages` are usually in in `resources/views/pages/` and the file structure determines routes:
3-
- `pages/index.blade.php` → `/`
4-
- `pages/profile/index.blade.php` → `/profile`
5-
- `pages/auth/login.blade.php` → `/auth/login`
6-
- List available Folio routes using `php artisan folio:list` or using Boost's `list-routes` tool.
3+
- Laravel Folio is a file based router. With Laravel Folio, a new route is created for every Blade file within the configured Folio directory. For example, pages are usually in in `resources/views/pages/` and the file structure determines routes:
4+
- `pages/index.blade.php` → `/`
5+
- `pages/profile/index.blade.php` → `/profile`
6+
- `pages/auth/login.blade.php` → `/auth/login`
7+
- You may list available Folio routes using `php artisan folio:list` or using Boost's `list-routes` tool.
78

8-
### Folio: New pages & routes
9+
### New Pages & Routes
910
- Always create new `folio` pages and routes using `artisan folio:page [name]` following existing naming conventions.
1011

1112
@verbatim
12-
<code-snippet name="Example folio:page commands for automatic routing" lang="shell">
13+
<code-snippet name="Example folio:page Commands for Automatic Routing" lang="shell">
1314
// Creates: resources/views/pages/products.blade.php → /products
1415
php artisan folio:page 'products'
1516

16-
1717
// Creates: resources/views/pages/products/[id].blade.php → /products/{id}
1818
php artisan folio:page 'products/[id]'
1919
</code-snippet>
2020
@endverbatim
2121

22-
- Add a 'name' to each new Folio page at the very top of the file, so it has a named route available for other parts of the codebase to use.
22+
- Add a 'name' to each new Folio page at the very top of the file so it has a named route available for other parts of the codebase to use.
23+
2324
@verbatim
2425
<code-snippet name="Adding named route to Folio page" lang="php">
2526
use function Laravel\Folio\name;
@@ -28,13 +29,12 @@
2829
</code-snippet>
2930
@endverbatim
3031

31-
32-
### Folio: Support & Docs
32+
### Support & Documentation
3333
- Folio supports: middleware, serving pages from multiple paths, subdomain routing, named routes, nested routes, index routes, route parameters, and route model binding.
3434
- If available, use Boost's `search-docs` tool to use Folio to its full potential and help the user effectively.
3535

3636
@verbatim
37-
<code-snippet name="Folio middleware example" lang="php">
37+
<code-snippet name="Folio Middleware Example" lang="php">
3838
use function Laravel\Folio\{name, middleware};
3939

4040
name('admin.products');

0 commit comments

Comments
 (0)