Automated Documentation for Laravel

Generate sequence diagrams, ERDs, UML diagrams, and API docs directly from your Laravel codebase.

Explore Features GitHub
Open Source Release Expected: End of May 2025

Features

What Laravel2Doc Offers

A comprehensive suite of documentation tools for Laravel developers.

Sequence Diagrams

Visualize request flows between frontend, controllers, models, and database with automated sequence diagrams.

Sample Sequence Diagram

ER Diagrams

Automatically generate Entity Relationship Diagrams showing your database structure and relationships.

Sample ER Diagram

UML Class Diagrams

Understand model relationships and class structures with automatically generated UML diagrams.

Sample UML Diagram

API Documentation

Auto-generate comprehensive API documentation with endpoints, parameters, and example requests.

Sample API Docs

CLI Tool

Simple command-line interface to generate all documentation with a single command.

$ npx laravel2doc Generating documentation...

Interactive Dashboard

View and navigate all generated documentation through a clean, interactive web interface.

Sample Dashboard

Technology

How Laravel2Doc Works

Under the hood with the sequence.js module

Code Analysis Process

  1. 1

    Controller Scanning

    Identifies all controller methods (index, show, store, etc.)

  2. 2

    Sequence Classification

    Categorizes actions based on RESTful conventions

  3. 3

    Model Discovery

    Finds related models and their relationships

  4. 4

    Query Analysis

    Identifies database queries triggered by each operation

  5. 5

    Diagram Generation

    Creates Mermaid.js-based sequence diagrams

Core Functions

generateSequenceDiagrams()

Scans all controllers and generates diagrams

generateShowSequence()

Handles show operations specifically

generateCSS()

Styles the dashboard output

generateJavaScript()

Adds interactivity to diagrams

generateIndexHTML()

Builds the main dashboard interface

Demo Video

Video: laravel2doc sequence diagram generation demo

Roadmap

Development Timeline

Stay tuned for updates and the official release!

Initial Development

March 2025

Completed

Core architecture and sequence diagram generation implemented.

ERD & UML Features

April 2025

Completed

Added Entity Relationship Diagrams and UML Class Diagram generation.

Beta Testing

May 2025

In Progress

Currently testing edge cases and improving the interactive dashboard.

Open Source Release

End of May 2025

Upcoming

Official GitHub repository launch with complete documentation.

Stay tuned for updates, resources, and links!

Ready to simplify your Laravel documentation? Get notified when we launch.

Star on GitHub

Contact

Get In Touch

Have questions or want to contribute? Reach out to us.

Send us a message

Contact Information

priom7197@gmail.com

github.com/Priom7/laravel2doc
https://www.linkedin.com/in/md-sharif-alam/
@priom7197