Generate Documentation in Laravel with AI

Last updated on by

Generate Documentation in Laravel with AI image

Docudoodle is a PHP documentation generator package for Laravel that analyzes your codebase and creates documentation using your AI of choice. Docudoodle helps you understand your codebase better and can help document legacy or existing codebases you've just started working with.

Example generated documentation using AI and Docudoodle
Example generated documentation using AI and Docudoodle

Once you've installed this package, you can generate the documentation using the package's Artisan command. Once completed, the documentation will be available in the documentation/ folder of your project:

php artisan docudoodle:generate

You can use the model of your choice, with the project offering OpenAI, Claude, Gemini, and Ollama configuration options. Here's the package's configuration options at the time of writing:

return [
'openai_api_key' => env('OPENAI_API_KEY', ''),
'claude_api_key' => env('CLAUDE_API_KEY', ''),
'default_model' => env('DOCUDOODLE_MODEL', 'gpt-4o-mini'),
'max_tokens' => env('DOCUDOODLE_MAX_TOKENS', 10000),
'default_extensions' => ['php', 'yaml', 'yml'],
'default_skip_dirs' => ['vendor/', 'node_modules/', 'tests/', 'cache/'],
'ollama_host' => env('OLLAMA_HOST', 'localhost'),
'ollama_port' => env('OLLAMA_PORT', '11434'),
'gemini_api_key' => env('GEMINI_API_KEY', ''),
'default_api_provider' => env('DOCUDOODLE_API_PROVIDER', 'openai'),
];

Main Features

  • Automatic Documentation Generation: Effortlessly generates documentation for PHP files by analyzing their content.
  • Flexible AI Integration: Choose between OpenAI's powerful cloud API, Claude API, Google's Gemini API, or run locally with Ollama models for complete privacy.
  • Ollama Support: Generate documentation completely offline using your own local Ollama models - perfect for private codebases or when you need to work without an internet connection.
  • Customizable: Easily configure source directories, output folders, and other settings to match your workflow.
  • Command-Line Interface: Includes a simple command-line script for quick documentation generation.

You can learn more about this package, get full installation instructions, and view the source code on GitHub. The package repository has a few examples so you can preview what to expect in the final documentation.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
Acquaint Softtech

Hire Laravel developers with AI expertise at $20/hr. Get started in 48 hours.

Visit Acquaint Softtech
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Laravel Cloud logo

Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Cloud
Acquaint Softtech logo

Acquaint Softtech

Acquaint Softtech offers AI-ready Laravel developers who onboard in 48 hours at $3000/Month with no lengthy sales process and a 100 percent money-back guarantee.

Acquaint Softtech
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $9500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
PhpStorm logo

PhpStorm

The go-to PHP IDE with extensive out-of-the-box support for Laravel and its ecosystem.

PhpStorm
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Harpoon: Next generation time tracking and invoicing logo

Harpoon: Next generation time tracking and invoicing

The next generation time-tracking and billing software that helps your agency plan and forecast a profitable future.

Harpoon: Next generation time tracking and invoicing

The latest

View all →
JSON Schema Deserialization in Laravel 13.14 image

JSON Schema Deserialization in Laravel 13.14

Read article
Generate Short, URL-Safe IDs From Numbers With Sqids image

Generate Short, URL-Safe IDs From Numbers With Sqids

Read article
Scheduler List: A Web Dashboard for Laravel's Scheduled Tasks image

Scheduler List: A Web Dashboard for Laravel's Scheduled Tasks

Read article
Community Laravel Extension for Zed image

Community Laravel Extension for Zed

Read article
Advanced Eloquent Query Filtering with Filterable image

Advanced Eloquent Query Filtering with Filterable

Read article
Bulk Job Dispatching with Bus::bulk() in Laravel 13.13 image

Bulk Job Dispatching with Bus::bulk() in Laravel 13.13

Read article