Skip to content

Commit 95063d6

Browse files
committed
feat: improve doc usage in guidelines
1 parent 33e4b60 commit 95063d6

File tree

5 files changed

+11
-8
lines changed

5 files changed

+11
-8
lines changed

.ai/boost/core.blade.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,13 @@
66

77
# Tinker / Debugging
88
You should use the ‘tinker’ tool from Boost MCP when you need to run PHP to check data, test code, or debug code.
9+
Prefer the database-query tool if you only need to query the database.
910

1011

1112
# Searching documentation
1213

14+
Check the docs before making code changes to ensure we are approaching this in the correct way. Use multiple simple topic based queries.
15+
1316
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.
1417

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@
77
- Infinite scrolling using merging props and WhenVisible
88
- Lazy loading data on scroll
99

10-
- When using <Deferred></Deferred> we should add a nice empty state with pulsing/animated skeleton/blocks.
10+
- When using deferred props on the frontend we should add a nice empty state with pulsing/animated skeleton/blocks. Check the docs before making any changes to ensure we are approaching this in the correct way.

.ai/pint/core.blade.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
## Pint Code Formatting Core
2-
- You must run `vendor/bin/pint` before finalizing changes to ensure your code matches the user's expected style.
2+
- You must run `vendor/bin/pint` before finalizing changes to ensure your code matches the project's expected style.

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,9 @@
77
<a href="https://packagist.org/packages/laravel/boost"><img src="https://img.shields.io/packagist/l/boost" alt="License"></a>
88
</p>
99

10-
> 5. Fill out the package long introduction in the readme
11-
> 7. Replace the `art/logo.svg` with the new package logo
12-
> 8. Replace the `public/favicon.ico` with the new package favicon (optional)
13-
> 9. Remove this quote block from your readme
14-
> 10. Write a great README
10+
> 1. Replace the `art/logo.svg` with the new package logo
11+
> 2. Replace the `public/favicon.ico` with the new package favicon (optional)
12+
> 3. Write a great README
1513
1614
## Introduction
1715
Laravel Boost gives you a jump-start with AI assisted coding by making it simple to add everything you need to help the AI make good choices.

src/Install/GuidelineComposer.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,9 @@ public function guidelines(): Collection
6666
*/
6767
protected function find(): Collection
6868
{
69-
$guidelines = collect(['boost/core' => $this->guideline('core')]);
69+
$guidelines = collect();
70+
$guidelines->put('core', $this->guideline('core'));
71+
$guidelines->put('boost/core', $this->guideline('boost/core'));
7072

7173
$phpMajorMinor = PHP_MAJOR_VERSION.'.'.PHP_MINOR_VERSION;
7274
$guidelines->put('php/core', $this->guideline('php/core'));

0 commit comments

Comments
 (0)