AI Documentation for Laravel Projects

Hosted docs for Laravel repos. Auto-generated, auto-updated nightly. Detects Eloquent models, Artisan commands, and conventions.

Free for public repos. No account needed.

What ReadmeBot detects in your project

ReadmeBot analyses your repository and automatically identifies key configuration files and project structure. Here are the files and patterns it looks for:

  • composer.json (laravel/framework)
  • artisan
  • routes/web.php
  • routes/api.php
  • .env.example

What's included in your documentation

Based on what ReadmeBot finds in your repository, it generates structured documentation with the following sections tailored to your stack:

Installation and setup

Configuration (.env)

Database and migrations

Artisan commands

Testing with Pest or PHPUnit

Frequently asked questions

Does it detect Laravel Sail?

Yes. ReadmeBot recognises Sail configuration and generates Docker-based setup instructions alongside traditional installation.

Will it document Eloquent models?

ReadmeBot identifies your Eloquent models and documents key relationships, scopes, and any custom methods.

Does it include queue and job documentation?

If your project uses Laravel queues, ReadmeBot documents queue configuration, available jobs, and worker setup instructions.

Generate READMEs for other technologies