Skip to content

Commit cdbaca0

Browse files
committed
working on guidelines
1 parent be37f15 commit cdbaca0

File tree

3 files changed

+30
-30
lines changed

3 files changed

+30
-30
lines changed

.ai/boost/core.blade.php

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
1-
## Boost
2-
- Boost MCP comes with powerful tools designed specifically for this application. Use them.
1+
## Laravel Boost
2+
- Laravel Boost is an MCP server that comes with powerful tools designed specifically for this application. Use them.
3+
4+
## Artisan
5+
- Use the `list-artisan-commands` tool when you need to call an Artisan command to double check the available parameters.
36

47
## URLs
58
- Whenever you share a project URL with the user you should use the `get-absolute-url` tool to ensure you're using the correct scheme, domain / IP, and port.
69

7-
## Artisan
8-
- Use the `list-artisan-commands` tool when you need to call an artisan command to triple check the available parameters.
9-
1010
## Tinker / Debugging
11-
- You should use the `tinker` tool from Boost MCP when you need to run PHP to debug code or query Eloquent models directly.
11+
- You should use the `tinker` tool when you need to execute PHP to debug code or query Eloquent models directly.
1212
- Use the `database-query` tool when you only need to read from the database.
1313

14-
@if(config('boost.browser_logs', true) !== false || config('boost.browser_logs_watcher', true) !== false)
15-
## Reading browser logs with the `browser-logs` tool
16-
- You can read browser logs, errors, and exceptions with the `browser-logs` tool from Boost.
17-
- Only recent browser logs will be useful, ignore old logs.
14+
@if (config('boost.browser_logs', true) !== false || config('boost.browser_logs_watcher', true) !== false)
15+
## Reading Browser Logs With the `browser-logs` Tool
16+
- You can read browser logs, errors, and exceptions using the `browser-logs` tool from Boost.
17+
- Only recent browser logs will be useful - ignore old logs.
1818
@endif
1919

20-
## Searching documentation (critically important)
21-
- Boost comes with a powerful `search-docs` tool you should use before any other approaches. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation specific for the user's circumstance. You should pass an array of packages to filter docs on if you know you need docs for particular packages.
22-
- The 'search-docs' tool is perfect for all Laravel related packages. Laravel, Inertia, Pest, Livewire, Nova, Nightwatch, etc..
23-
- You must use this tool to search for Laravel-ecosystem docs before falling back to other approaches.
24-
- Search the docs before making code changes to ensure we are approaching this in the correct way.
25-
- Use multiple broad simple topic based queries to start, i.e. `rate limiting##routing rate limiting##routing`.
20+
## Searching Documentation (Critically Important)
21+
- Boost comes with a powerful `search-docs` tool you should use before any other approaches. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation specific for the user's circumstance. You should pass an array of packages to filter on if you know you need docs for particular packages.
22+
- The 'search-docs' tool is perfect for all Laravel related packages, including Laravel, Inertia, Livewire, Pest, Nova, Nightwatch, etc.
23+
- You must use this tool to search for Laravel-ecosystem documentation before falling back to other approaches.
24+
- Search the documentation before making code changes to ensure we are taking the correct approach.
25+
- Use multiple, broad, simple, topic based queries to start. For example: `rate limiting##routing rate limiting##routing`.
2626

27-
### Available search syntax
28-
- You can and should pass multiple queries at once, the most relevant results will be returned first.
27+
### Available Search Syntax
28+
- You can and should pass multiple queries at once. The most relevant results will be returned first.
2929

3030
1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth'
3131
2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit"
3232
3. Quoted Phrases (Exact Position) - query="infinite scroll - Words must be adjacent and in that order
3333
4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit"
3434
5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms
35-

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

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
- This project is using Flux UI - Free. It has full access to the free components and variants, but does not have access to the Pro components.
1+
- 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.
22
- 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.
33
- You should use Flux UI components when available.
4+
- Fallback to standard Blade components if Flux is unavailable.
5+
- If available, use Laravel Boost's `search-docs` tool to get the exact documentation and code snippets available for this project.
46
- Flux UI components look like this:
5-
<code-snippet name="Flux UI component usage example" lang="blade">
7+
<code-snippet name="Flux UI Component Usage Example" lang="blade">
68
<flux:button variant="primary"/>
79
</code-snippet>
8-
- Fallback to standard Blade components if Flux is unavailable.
9-
- If available, use Laravel Boost's `search-docs` tool to get the exact documentation and code snippets available for this project.
1010

11-
### List of available components
12-
This is correct as of Boost install, but there may be additional ones within the codebase.
11+
## Available Components
12+
This is correct as of Boost installation, but there may be additional components within the codebase.
13+
1314
<available-flux-components>
1415
avatar, badge, brand, breadcrumbs, button, callout, checkbox, dropdown, field, heading, icon, input, modal, navbar, profile, radio, select, separator, switch, text, textarea, tooltip
1516
</available-flux-components>

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
- This project is using Flux UI - Pro. It has full access to the free components and variants, as well as full access to the Pro components and variants.
1+
- 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.
22
- 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.
33
- You should use Flux UI components when available.
4+
- Fallback to standard Blade components if Flux is unavailable.
5+
- If available, use Laravel Boost's `search-docs` tool to get the exact documentation and code snippets available for this project.
46
- Flux UI components look like this:
57
<code-snippet name="Flux UI component usage example" lang="blade">
68
<flux:button variant="primary"/>
79
</code-snippet>
8-
- Fallback to standard Blade components if Flux is unavailable.
9-
- If available, use Laravel Boost's `search-docs` tool to get the exact documentation and code snippets available for this project.
1010

11-
### List of available components
12-
This is correct as of Boost install, but there may be additional ones within the codebase.
11+
## Available Components
12+
This is correct as of Boost installation, but there may be additional components within the codebase.
1313

1414
<available-flux-components>
1515
accordion, autocomplete, avatar, badge, brand, breadcrumbs, button, calendar, callout, card, chart, checkbox, command, context, date-picker, dropdown, editor, field, heading, icon, input, modal, navbar, pagination, popover, profile, radio, select, separator, switch, table, tabs, text, textarea, toast, tooltip

0 commit comments

Comments
 (0)