Skip to content

Commit c6fce23

Browse files
committed
feat: bunch of guidelines, nicer install command, add ENV to herd mcp, browser logs, report feedback tool
1 parent f710ede commit c6fce23

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+693
-140
lines changed

.ai/boost/core.blade.php

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
1+
# URLs
2+
- Whenever you create a URL use the `get-absolute-url` tool to ensure you're using the correct scheme, domain/IP, and port.
3+
4+
# Artisan
5+
- Use the `list-artisan-commands` tool when needing to call an artisan command to triple check the available params
6+
7+
# Tinker / Debugging
8+
You should use the ‘tinker’ tool from Boost MCP when you need to run PHP to check data, test code, or debug code.
9+
10+
111
# Searching documentation
212

3-
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.
13+
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.
414

515
'search-docs' tool is perfect for all Laravel related packages. Laravel, inertia, pest, livewire, nova, nightwatch, and more.
616

@@ -15,10 +25,3 @@
1525
4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit"
1626
5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms
1727

18-
# URLs
19-
20-
- Whenever you create a URL use the `get-absolute-url` tool to ensure you're using the correct scheme, domain/IP, and port.
21-
22-
23-
# Artisan
24-
- Use the `list-artisan-commands` tool when needing to call an artisan command to triple check the available params

.ai/core.blade.php

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,42 @@
11
# Laravel Boost Guidelines
22
The Laravel Boost Guidelines are specifically curated by Laravel maintainers for this project. These guidelines should be followed closely to help enhance the user's experience and satisfaction.
33

4+
# Foundational Context
5+
This project is a Laravel app and its main Laravel ecosystems package & versions are below. You are an expert with them all. Ensure we abide by these specific packages & versions.
6+
7+
- php - {{ PHP_VERSION }}
8+
@foreach (app(\Laravel\Roster\Roster::class)->packages()->unique(fn ($package) => $package->rawName()) as $package)
9+
- {{ $package->rawName() }} ({{ $package->name() }}) - v{{ $package->majorVersion() }}
10+
@endforeach
11+
412
@if(!empty(config('boost.project_purpose')))
5-
<purpose-of-this-project>
6-
{!! config('boost.project_purpose') !!}
7-
</purpose-of-this-project>
13+
Project purpose: {!! config('boost.project_purpose') !!}
814
@endif
915

10-
# Conventions
11-
Follow existing conventions. When creating or editing a file, check sibling files for the correct structure, approach, naming.
16+
## Conventions
17+
- You must follow all existing code conventions used in this project. When creating or editing a file, check sibling files for the correct structure, approach, naming.
18+
- Use descriptive names. e.g. `isRegisteredForDiscounts` not `discount()`
19+
- Always use strict typing: declare(strict_types=1);
20+
21+
## Project Structure & Architecture
22+
- Stick to existing directory structure - no new base folders without approval.
23+
- No dependency changes without approval.
24+
25+
## Constructors
26+
- Use PHP 8 constructor property promotion in `__construct()`
27+
<code-snippet>public function __construct(public GitHub $github) { }</code-snippet>
28+
- Do not allow empty `__construct()` with zero parameters.
29+
30+
## Type Declarations
31+
- Always use explicit return type declarations for methods and functions.
32+
- Use appropriate PHP type hints for method parameters.
33+
34+
## Comments
35+
- Prefer PHPDoc blocks, otherwise use minimal-to-zero comments, unless there is something very complex going on.
36+
37+
## Replies
38+
- Be concise in your explanations - focus on what's important rather than explaining obvious details.
39+
40+
## Documentation files
41+
- You must only create documentation files if explicitly requested by the user.
42+

.ai/enforce-tests.blade.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
11
- Every change must be programmatically tested. Write a new test, or update an existing test, then run the tests to make sure they pass.
2-
- Run the individual tests edited to

.ai/fluxui_free/core.blade.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- **Use Flux UI components** when available
2+
- Fallback to standard Blade components if Flux is unavailable.
3+
- Use Laravel Boost's `search-docs` tool to get the exact documentation & code snippets available for this project.

.ai/fluxui_pro/core.blade.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- **Use Flux UI components** when available
2+
- Fallback to standard Blade components if Flux is unavailable.
3+
- Use Laravel Boost's `search-docs` tool to get the exact documentation & code snippets available for this project.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Inertia v1 core.md
1+
Inertia v1 core
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Inertia v2 core.md
1+
Inertia v2 core

.ai/inertia-laravel/core.blade.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
## InertiaJS Laravel Package
2-
3-
Super core inertia js laravel package
1+
## InertiaJS Laravel Package Core

.ai/laravel/10/core.blade.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Laravel 10 Core.md
1+
Laravel 10 Core

.ai/laravel/11/core.blade.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
Laravel 11 Core.md
1+
Laravel 11 Core
2+
3+
- **No app\Console\Kernel.php** - use `bootstrap/app.php` for console configurations
4+
- **Commands auto-register** - files in `app/Console/Commands/` are automatically available

0 commit comments

Comments
 (0)