Laravel Docs Reader — Skill Specification

Overview

Skill Name: Laravel Docs Reader Type: Development Reference Skill Target: OpenClaw Agent and Laravel developers Version: 1.0.0

Core Objectives

1. Provide instant, accurate access to official Laravel documentation during coding
2. Auto-detect the local Laravel version and serve the correct docs
3. Generate standard Laravel code that conforms to Laravel best practices and PSR-12
4. Highlight version differences across Laravel 10 / 11 / 12
5. Keep references up to date via GitHub Actions auto-PR

Version Support

Version Detection (Auto-Switch)

When the agent runs on a project, it auto-detects Laravel version:

1. composer.json → "laravel/framework": "^12.x"
2. artisan --version
3. vendor/laravel/framework/src/Illuminate/Foundation/Application.php → VERSION constant

Detection path: references/version-detection.md

CLI Tool

php laradoc.php \x3Ccommand> [args]

Search Coverage

Code Generation

The generate command outputs standard Laravel code for:

• controller — RESTful API controller
• model — Eloquent model with fillable/casts/relationships
• job — Queueable job with failed handler
• middleware — HTTP middleware
• request — Form Request validation
• notification — Multi-channel notification
• factory — Model factory for testing

All output follows PSR-12 and Laravel conventions.

Version Diff

Auto-Update Mechanism

A GitHub Actions workflow runs weekly to:

1. Fetch latest laravel/framework version from Packagist
2. Compare against the skill's default version
3. If new version detected → auto-create a PR with updated references

.github/workflows/update-docs.yml
  ├── Schedule: Every Sunday 00:00 UTC
  └── Creates PR: updates SKILL.md + version-detection.md

Anyone using this skill can review the auto-PR and merge after verification.

File Structure

laravel-docs-reader/
├── SKILL.md                          # This file
├── README.md                          # English (default)
├── README.zh-CN.md                    # Chinese
├── .github/
│   └── workflows/
│       └── update-docs.yml            # Auto-update PR workflow
├── .cache/                          # Local doc cache (auto-created)
├── references/
│   ├── version-detection.md           # Version detection logic
│   ├── version-diff.md                # Version diff table (10/11/12)
│   ├── psr-12.md                    # PSR-12 quick reference
│   ├── api-index.md                  # Full API index
│   ├── artisan-commands.md           # All artisan commands
│   ├── facades.md                   # Facade method signatures
│   ├── blade-directives.md           # All Blade directives
│   ├── config-ref.md               # Config file reference
│   └── examples/
│       ├── controller.md
│       ├── model.md
│       ├── migration.md
│       ├── middleware.md
│       ├── queue-job.md
│       ├── notification.md
│       └── testing.md
└── scripts/
    └── laradoc.php                  # CLI tool (14 commands)

PSR-12 Quick Reference

Built-in PSR-12 standard reference — no external formatter needed:

php laradoc.php psr                  # Full PSR-12 table (rules + examples)
php laradoc.php psr arrays          # Arrays rule
php laradoc.php psr naming          # Naming conventions (class/method/var/const)
php laradoc.php psr methods         # Visibility + method rules
php laradoc.php psr namespace       # use statements
php laradoc.php psr operators       # Operator spacing

Topics: arrays, naming, methods, control, namespace, operators

Local Cache (Offline Mode)

The skill stores docs in .cache/ for fast, offline access:

php laradoc.php cache  # Show cache status, size, age, offline availability
php laradoc.php update  # Force-refresh from GitHub

Cache is created automatically on first search. All bundled reference files work without internet.

Auto-Update & Subscription

GitHub Actions runs weekly (Sunday 00:00 UTC):

• Detects new laravel/framework version from Packagist
• Auto-creates PR updating SKILL.md, version-detection.md, version-diff.md
• User reviews PR → merges when ready

php laradoc.php subscribe  # Show current subscription / update status

Laravel Package Search Cross-Link

After every search result, the agent suggests laravel-package-search for third-party package discovery.

Usage in OpenClaw

When the agent needs to write Laravel code:

1. Auto-detect project Laravel version
2. Map the request to the correct doc section
3. Return:
   • Official documentation summary
   • Code example (PSR-12, Laravel best practice)
   • Version differences (if applicable)
   • Notes / caveats

Evaluation Criteria

Each doc entry is rated on:

Publishing

clawhub login --token \x3CTOKEN>
clawhub publish laravel-docs-reader

Or submit at https://clawhub.com