Skip to content

Commit 8ef12fb

Browse files
committed
adds docs
1 parent 517fcd1 commit 8ef12fb

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,25 @@ Laravel Boost includes AI guidelines for the following packages and frameworks.
8181
| Laravel Folio | core |
8282
| Enforce Tests | conditional |
8383

84+
### Keeping Guidelines Up-to-Date
85+
86+
You may want to periodically update your local AI guidelines to ensure they reflect the latest versions of the Laravel ecosystem packages you have installed. To do so, you can use the `boost:update` Artisan command.
87+
88+
```bash
89+
php artisan boost:update
90+
```
91+
92+
You may also automate this process by adding it to your Composer "post-update-cmd" scripts:
93+
94+
```json
95+
{
96+
"scripts": {
97+
"post-update-cmd": [
98+
"@php artisan boost:update --ansi"
99+
]
100+
}
101+
}
102+
```
84103

85104
## Available Documentation
86105

@@ -106,6 +125,29 @@ You can override Boost's built-in AI guidelines by creating your own custom guid
106125

107126
For example, to override Boost's "Inertia React v2 Form Guidance" guidelines, create a file at `.ai/guidelines/inertia-react/2/forms.blade.php`. When you run `boost:install`, Boost will include your custom guideline instead of the default one.
108127

128+
## Third-Party Package AI Guidelines
129+
130+
If you maintain a third-party package and would like Boost to include AI guidelines for it, you can do so by adding a `resources/boost/guidelines/core.blade.php` file to your package. When users of your package run `php artisan boost:install`, Boost will automatically load your guidelines.
131+
132+
AI guidelines should provide a short overview of what your package does, outline any required file structure or conventions, and explain how to create or use its main features (with example commands or code snippets). Keep them concise, actionable, and focused on best practices so AI can generate correct code for your users. Here is an example:
133+
134+
```php
135+
## Package Name
136+
137+
This package provides [brief description of functionality].
138+
139+
### Features
140+
141+
- Feature 1: [clear & short description].
142+
- Feature 2: [clear & short description]. Example usage:
143+
144+
@verbatim
145+
<code-snippet name="How to use Feature 2" lang="php">
146+
$result = PackageName::featureTwo($param1, $param2);
147+
</code-snippet>
148+
@endverbatim
149+
```
150+
109151
## Manually Registering the Boost MCP Server
110152

111153
Sometimes you may need to manually register the Laravel Boost MCP server with your editor of choice. You should register the MCP server using the following details:

0 commit comments

Comments
 (0)