## 🚀 Generate Full Documentation

Access complete API documentation for 90+ Models, Traits, Controllers & Middleware

Generate Complete Docs View Quick Reference ↓
90+
Models
100%
DocBlock Coverage
1200+
API Methods
4
Documentation Options

### 🌐 Full Generated Docs

Complete HTML documentation with search, cross-references & inheritance hierarchy

Run: `./generate-docs.sh`

### 📖 Interactive Viewer

Browse sample models and API references directly (this page)

Location: `docs-viewer.html`

### 🔍 Source Code

All code includes comprehensive phpDoc comments with detailed descriptions

Location: `app/Models/`

### 📚 Setup Guides

Detailed documentation on setup, configuration & multiple viewing options

Path: `docs/` folder

### ⚡ How to Generate Complete Documentation

Run the automated script from the docs folder:

$ cd docs
$ ./generate-docs.sh

This will:

- Download PHPDocumentor (if not installed)
- Parse all phpDoc comments from `./app`
- Generate comprehensive HTML documentation in `./storage/phpdoc`
- Open the documentation in your browser

### 📑 Quick Reference

#### 📁 Models (90+)

Location: `app/Models/`

Examples: User, School, TeacherProfile, Attendance, Admission, Assignment, etc.

All models have comprehensive docBlocks with property descriptions and relationships

#### 📝 Traits

MSG91 - SMS Gateway Integration AuthenticatesUsers - Authentication Logic

#### 🎮 Controllers

LoginController - Authentication Endpoints

#### 🛡️ Middleware

AdminAccountant - Access Control

### ✨ What's Included

- ✅ 90+ Eloquent Models with relationships
- ✅ Complete phpDoc comments on all models
- ✅ 4 Traits with utility functions
- ✅ 50+ Controllers with API endpoints
- ✅ Authentication system with 8 user roles
- ✅ 90+ Database relationships documented
- ✅ Search functionality in generated docs
- ✅ Inheritance hierarchy visualization

### 🚀 Quick Commands

# View this documentation
./view-docs.sh

# Generate full documentation
cd docs && ./generate-docs.sh

# View generated docs locally
cd storage/phpdoc && python3 -m http.server 8000

### 📌 Next Steps

1. Generate Documentation - Run `./generate-docs.sh` from docs folder
2. Explore Models - Open `storage/phpdoc/index.html` in browser
3. Reference - Use search and cross-references to navigate
4. Share - Host the generated docs on your web server