add tests

Author: bambamboole

.ai/guidelines/documentation.blade.php

@@ -1,2 +1,142 @@
-# Documentation conventions
+# Laravel Docs - Functional Documentation Guidelines
 
+This project uses the `xentral/laravel-docs` package to automatically generate documentation from PHPDoc comments using the `@functional` annotation.
+
+## How to Write Functional Documentation
+
+### Basic Structure
+
+```php
+/**
+ * Brief summary of the class/method
+ * 
+ * @functional
+ * Detailed description of the functionality. This can span multiple lines
+ * and supports full Markdown formatting.
+ * 
+ * # Features
+ * - Feature 1: Description
+ * - Feature 2: Description
+ * 
+ * @nav Navigation / Path / For This Doc
+ * @uses \App\Models\User
+ * @uses \App\Services\EmailService
+ * @link https://example.com/related-docs
+ */
+```
+
+### Required Annotations
+
+- **`@functional`**: Must be present to include the documentation in generation
+- All other annotations are optional but recommended
+
+### Optional Annotations
+
+- **`@nav Path / To / Documentation`**: Defines where this appears in the navigation
+- **`@uses \Fully\Qualified\ClassName`**: Links to dependencies for relationship mapping
+- **`@link URL`** or **`@links [Title](URL)`**: External references
+
+### Best Practices
+
+1. **Be Descriptive**: Explain the "why" and "how", not just the "what"
+2. **Use Markdown**: Headers, lists, code blocks, and links are all supported
+3. **Group Related Items**: Use consistent navigation paths for related functionality
+4. **Document Dependencies**: Use `@uses` to show relationships between components
+5. **Add Examples**: Include code examples where helpful
+
+### Navigation Structure
+
+Organize your documentation using consistent navigation paths:
+
+```
+Authentication/
+├── Login Process
+├── Password Reset
+└── Session Management
+
+User Management/
+├── User Registration
+├── Profile Updates
+└── Account Deletion
+```
+
+### Markdown Features
+
+Full Markdown support includes:
+
+- **Headers** (automatically demoted by one level)
+- **Lists** and nested lists
+- **Code blocks** with syntax highlighting
+- **Mermaid diagrams** for flowcharts
+- **Links** and images
+- **Tables** and formatting
+
+### Example Documentation
+
+```php
+/**
+ * Payment processing service
+ * 
+ * @functional
+ * This service handles all payment operations including processing payments,
+ * refunds, and subscription management. It integrates with multiple payment
+ * gateways and provides a unified interface for payment operations.
+ * 
+ * # Key Features
+ * - **Multi-gateway Support**: Stripe, PayPal, Square
+ * - **Subscription Management**: Recurring billing and plan changes
+ * - **Fraud Protection**: Built-in fraud detection and prevention
+ * 
+ * ## Usage Example
+ * 
+ * ```php
+ * $payment = $paymentService->processPayment([
+ *     'amount' => 2999, // $29.99
+ *     'currency' => 'USD',
+ *     'customer_id' => $user->id,
+ * ]);
+ * ```
+ * 
+ * ## Error Handling
+ * 
+ * The service throws specific exceptions for different failure modes:
+ * - `PaymentDeclinedException` for declined cards
+ * - `InsufficientFundsException` for NSF situations
+ * - `InvalidPaymentMethodException` for invalid payment methods
+ * 
+ * @nav Payments / Payment Processing
+ * @uses \App\Models\User
+ * @uses \App\Models\PaymentMethod
+ * @uses \App\Services\FraudDetectionService
+ * @link https://stripe.com/docs/api
+ */
+```
+
+## Generating Documentation
+
+```bash
+# Generate documentation
+php artisan mkdocs:generate
+
+# Serve documentation locally
+php artisan mkdocs:serve
+
+# Generate with custom output path
+php artisan mkdocs:generate --path=/custom/docs/path
+```
+
+## Configuration
+
+Configure paths to scan in `config/docs.php`:
+
+```php
+'paths' => [
+    app_path(),
+    base_path('packages/'),
+    // Add other directories to scan
+],
+```
+
+---
+
+For more information, see the package documentation at https://github.com/xentral/laravel-docs

.junie/mcp/mcp.json

@@ -0,0 +1,11 @@
+{
+    "mcpServers": {
+        "laravel-boost": {
+            "command": "/Users/bambamboole/Library/Application Support/Herd/bin/php82",
+            "args": [
+                "/Users/bambamboole/Projects/laravel-docs/vendor/orchestra/testbench-core/laravel/artisan",
+                "boost:mcp"
+            ]
+        }
+    }
+}

.mcp.json

@@ -0,0 +1,11 @@
+{
+    "mcpServers": {
+        "laravel-boost": {
+            "command": "php",
+            "args": [
+                "./artisan",
+                "boost:mcp"
+            ]
+        }
+    }
+}

CLAUDE.md

@@ -0,0 +1,108 @@
+<laravel-boost-guidelines>
+=== foundation rules ===
+
+# Laravel Boost Guidelines
+
+The Laravel Boost guidelines are specifically curated by Laravel maintainers for this application. These guidelines should be followed closely to enhance the user's satisfaction building Laravel applications.
+
+## Foundational Context
+This application is a Laravel application and its main Laravel ecosystems package & versions are below. You are an expert with them all. Ensure you abide by these specific packages & versions.
+
+- php - 8.2.29
+
+
+## Conventions
+- You must follow all existing code conventions used in this application. When creating or editing a file, check sibling files for the correct structure, approach, naming.
+- Use descriptive names for variables and methods. For example, `isRegisteredForDiscounts`, not `discount()`.
+- Check for existing components to reuse before writing a new one.
+
+## Verification Scripts
+- Do not create verification scripts or tinker when tests cover that functionality and prove it works. Unit and feature tests are more important.
+
+## Application Structure & Architecture
+- Stick to existing directory structure - don't create new base folders without approval.
+- Do not change the application's dependencies without approval.
+
+## Frontend Bundling
+- If the user doesn't see a frontend change reflected in the UI, it could mean they need to run `npm run build`, `npm run dev`, or `composer run dev`. Ask them.
+
+## Replies
+- Be concise in your explanations - focus on what's important rather than explaining obvious details.
+
+## Documentation Files
+- You must only create documentation files if explicitly requested by the user.
+
+
+=== boost rules ===
+
+## Laravel Boost
+- Laravel Boost is an MCP server that comes with powerful tools designed specifically for this application. Use them.
+
+## Artisan
+- Use the `list-artisan-commands` tool when you need to call an Artisan command to double check the available parameters.
+
+## URLs
+- 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.
+
+## Tinker / Debugging
+- You should use the `tinker` tool when you need to execute PHP to debug code or query Eloquent models directly.
+- Use the `database-query` tool when you only need to read from the database.
+
+## Reading Browser Logs With the `browser-logs` Tool
+- You can read browser logs, errors, and exceptions using the `browser-logs` tool from Boost.
+- Only recent browser logs will be useful - ignore old logs.
+
+## Searching Documentation (Critically Important)
+- 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.
+- The 'search-docs' tool is perfect for all Laravel related packages, including Laravel, Inertia, Livewire, Filament, Tailwind, Pest, Nova, Nightwatch, etc.
+- You must use this tool to search for Laravel-ecosystem documentation before falling back to other approaches.
+- Search the documentation before making code changes to ensure we are taking the correct approach.
+- Use multiple, broad, simple, topic based queries to start. For example: `['rate limiting', 'routing rate limiting', 'routing']`.
+- Do not add package names to queries - package information is already shared. For example, use `test resource table`, not `filament 4 test resource table`.
+
+### Available Search Syntax
+- You can and should pass multiple queries at once. The most relevant results will be returned first.
+
+1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth'
+2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit"
+3. Quoted Phrases (Exact Position) - query="infinite scroll" - Words must be adjacent and in that order
+4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit"
+5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms
+
+
+=== php rules ===
+
+## PHP
+
+- Always use curly braces for control structures, even if it has one line.
+
+### Constructors
+- Use PHP 8 constructor property promotion in `__construct()`.
+    - <code-snippet>public function __construct(public GitHub $github) { }</code-snippet>
+- Do not allow empty `__construct()` methods with zero parameters.
+
+### Type Declarations
+- Always use explicit return type declarations for methods and functions.
+- Use appropriate PHP type hints for method parameters.
+
+<code-snippet name="Explicit Return Types and Method Params" lang="php">
+protected function isAccessible(User $user, ?string $path = null): bool
+{
+    ...
+}
+</code-snippet>
+
+## Comments
+- Prefer PHPDoc blocks over comments. Never use comments within the code itself unless there is something _very_ complex going on.
+
+## PHPDoc Blocks
+- Add useful array shape type definitions for arrays when appropriate.
+
+## Enums
+- Typically, keys in an Enum should be TitleCase. For example: `FavoritePerson`, `BestLake`, `Monthly`.
+
+
+=== .ai/documentation rules ===
+
+# Documentation conventions
+</laravel-boost-guidelines>