PHPackages karlost/digidocs - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. karlost/digidocs ActiveLibrary[Utility & Helpers](/categories/utility) karlost/digidocs ================ AI-powered Laravel documentation generator with dual documentation types (developer + user) and intelligent change analysis 0.3.1(11mo ago)03MITPHPPHP ^8.2 Since May 25Pushed 11mo agoCompare [ Source](https://github.com/karlost/digidocs)[ Packagist](https://packagist.org/packages/karlost/digidocs)[ Docs](https://github.com/karlost/digidocs)[ RSS](/packages/karlost-digidocs/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (9)Versions (6)Used By (0) Digidocs - AI-Powered Laravel Documentation Generator ===================================================== [](#digidocs---ai-powered-laravel-documentation-generator) [![Version](https://camo.githubusercontent.com/5239de4aa8a0e457cb3b4b799769202ed8d60662e9fc22ebffaf407fb930124f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f76657273696f6e2d302e332e302d626c75652e737667)](https://github.com/karlost/digidocs)[![Laravel](https://camo.githubusercontent.com/36ab9eb40d419c375ec1c19e6d5fd0d5ae0aeb01372cc6b164966c412feecdad/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d31302532422d7265642e737667)](https://laravel.com)[![PHP](https://camo.githubusercontent.com/789befc8d88593153c7b6252f5256360c9532b26eb84fcb39b1ab842cc239e9d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e322532422d707572706c652e737667)](https://php.net) Digidocs is an advanced Laravel package that automatically generates comprehensive documentation using AI. It creates both **developer documentation** (technical API docs) and **user documentation** (end-user guides) with intelligent change analysis and real-time Git monitoring. ✨ Key Features -------------- [](#-key-features) ### πŸ“š Dual Documentation Types [](#-dual-documentation-types) - πŸ‘¨β€πŸ’» **Developer Documentation** - Technical API docs for code maintainers - πŸ‘₯ **User Documentation** - End-user guides for application users - 🧠 **Intelligent routing** - Automatically determines which type to generate ### πŸ€– AI-Powered Generation [](#-ai-powered-generation) - πŸ€– **Advanced AI models** - Uses OpenAI/GPT-4, Claude, Gemini, and more - 🧠 **Intelligent change analysis** - Separate agents for developer vs user impact - πŸ“Š **Context-aware** - Understands Laravel patterns and user workflows ### πŸ”„ Smart Change Detection [](#-smart-change-detection) - 🎯 **UserChangeAnalysisAgent** - Analyzes UI/UX impact for user docs - πŸ› οΈ **ChangeAnalysisAgent** - Analyzes API changes for developer docs - πŸ“‹ **Documented parts tracking** - Tracks which code parts are documented - πŸ”„ **Git commit monitoring** - Processes only changed files ### ⚑ Advanced Features [](#-advanced-features) - 🌍 **Universal Language Support** - Any ISO language code (cs-CZ, ja-JP, ar-SA, zh-CN, etc.) - πŸ‘οΈ **Real-time watch mode** - Continuous monitoring with automatic regeneration - πŸ“Š **Semantic analysis** - Distinguishes between public API and private changes - πŸ’Ύ **SQLite tracking** - Efficient tracking of changes, analyses and documentation - πŸ› οΈ **NeuronAI architecture** - Modular system with specialized Agents and Tools - πŸ” **Laravel context** - Recognizes Controllers, Models, Blade templates, Routes - πŸ’° **Cost tracking** - Detailed token usage and cost statistics - 🎯 **High efficiency** - Skip rate up to 85% thanks to intelligent analysis πŸš€ Installation -------------- [](#-installation) ``` composer require karlost/digidocs ``` βš™οΈ Configuration ---------------- [](#️-configuration) ``` # 1. Publish configuration file php artisan vendor:publish --tag=digidocs-config # 2. Set API key in .env AUTODOCS_AI_KEY=your-openai-api-key # 3. Configure languages in .env (optional) DIGIDOCS_LANGUAGES=cs-CZ,en-US,ja-JP DIGIDOCS_DEFAULT_LANGUAGE=cs-CZ ``` ### 🌍 Language Configuration [](#-language-configuration) DigiDocs supports **any ISO language code** without code modifications: ``` // config/digidocs.php 'languages' => [ 'enabled' => ['cs-CZ', 'en-US', 'ja-JP', 'de-DE', 'pl-PL', 'zh-CN'], 'default' => 'cs-CZ', ], ``` **Supported examples:** - `cs-CZ` (Czech), `en-US` (English), `de-DE` (German) - `ja-JP` (Japanese), `ko-KR` (Korean), `zh-CN` (Chinese) - `ar-SA` (Arabic), `hi-IN` (Hindi), `th-TH` (Thai) - `pt-BR` (Portuguese Brazil), `es-MX` (Spanish Mexico) - **Any ISO 639-1 + ISO 3166-1 combination!** AI automatically recognizes and generates documentation in the specified language. πŸ“‹ Usage ------- [](#-usage) ### οΏ½β€πŸ’» Developer Documentation (Technical API Docs) [](#‍-developer-documentation-technical-api-docs) ``` php artisan digidocs:autodocs [options] ``` **Available options:** - `--force` - Force regeneration even for unchanged files - `--dry-run` - Show what would be processed without generating - `--path=PATH` - Process specific paths (can be used multiple times) - `--stats` - Show documentation statistics - `--cost` - Show token usage and cost statistics - `--cleanup` - Clean database from non-existent files **Intelligent analysis:** - 🧠 **ChangeAnalysisAgent** decides whether to regenerate documentation - βœ… **Public API changes** β†’ Regenerates documentation - ⏭️ **Private changes/whitespace** β†’ Skips regeneration - πŸ“Š **Tracks documented parts** of code for more precise decisions ### πŸ‘₯ User Documentation (End-User Guides) [](#-user-documentation-end-user-guides) ``` php artisan digidocs:userdocs [options] ``` **Available options:** - `--lang=ISO_CODE` - Generate in specific language (e.g., `--lang=ja-JP`) - `--force` - Force regeneration of all user documentation - `--dry-run` - Show what would be processed without generating - `--stats` - Show documentation statistics - `--cost` - Show token usage and cost statistics **Language examples:** ``` php artisan digidocs:userdocs --lang=cs-CZ # Czech php artisan digidocs:userdocs --lang=ja-JP # Japanese php artisan digidocs:userdocs --lang=ar-SA # Arabic ``` **User documentation features:** - 🎯 **UserChangeAnalysisAgent** - Analyzes changes from user perspective - πŸ–₯️ **UI/UX focus** - Prioritizes Blade templates, routes, and user-facing changes - πŸ“± **Application-level docs** - Generates structured guides with sections - πŸ”„ **Smart regeneration** - Only updates when user experience is affected - πŸ“Š **Impact scoring** - Rates changes by user impact (0-100) - πŸ“‚ **Section-based organization** - Organizes content by user workflows - πŸ”— **Cross-references** - Links between related sections ### πŸš€ All Documentation (Combined Generation) [](#-all-documentation-combined-generation) ``` php artisan digidocs:alldocs [options] ``` **Available options:** - `--lang=ISO_CODE` - Generate user docs in specific language (e.g., `--lang=pl-PL`) - `--code-only` - Generate only developer documentation - `--user-only` - Generate only user documentation - `--all` - Process all files for code documentation (not just Git changes) - `--force` - Force regeneration of all documentation - `--path=PATH` - Specific paths to process for code docs **Examples:** ``` php artisan digidocs:alldocs # Both types, default language php artisan digidocs:alldocs --lang=ja-JP # Both types in Japanese php artisan digidocs:alldocs --code-only --all # Only developer docs, all files ``` ### πŸ‘οΈ Watch Mode - Real-time Git Commit Monitoring [](#️-watch-mode---real-time-git-commit-monitoring) ``` php artisan digidocs:watch [options] ``` **Available options:** - `--interval=SECONDS` - Check interval in seconds (default: 5) - `--path=PATH` - Specific paths to watch (can be used multiple times) - `--code-only` - Generate only developer documentation - `--user-only` - Generate only user documentation **Watch mode features:** - πŸ”„ **Real-time monitoring** - Monitors Git commits continuously - 🧠 **Intelligent analysis** - Separate agents for dev vs user docs - 🎯 **Smart filtering** - Only processes relevant changes - πŸ›‘ **Graceful shutdown** - Ctrl+C for clean exit - πŸ“š **Unified processing** - Both documentation types in one command πŸ€– Supported AI Providers ------------------------ [](#-supported-ai-providers) **Tested and verified:** - βœ… **OpenAI GPT-4.1 Nano** - Fully tested and optimized (recommended) **Supported but not extensively tested:** - πŸ”Ά **OpenAI** - GPT-4o, GPT-4, GPT-3.5, O3, O4-mini - πŸ”Ά **Anthropic** - Claude 4, Claude 3.7, Claude 3.5, Claude 3 - πŸ”Ά **Gemini** - Gemini 1.5 Pro/Flash, Gemini 2.0 Flash - πŸ”Ά **Deepseek** - Deepseek Chat/Coder - πŸ”Ά **Mistral** - Mistral Large/Medium/Small - πŸ”Ά **Ollama** - Local models (free) **Note:** All testing was performed with GPT-4.1 Nano model. Other providers are supported through NeuronAI framework but may require additional configuration or testing. **Automatic pricing:**Model prices are configurable in `config/digidocs/pricing.php`. πŸ’‘ Quick Start ------------- [](#-quick-start) ``` # 1. Install and configure composer require karlost/digidocs php artisan vendor:publish --tag=digidocs-config # 2. Set API key in .env AUTODOCS_AI_KEY=your-openai-api-key # 3. Generate documentation php artisan digidocs:autodocs # Developer documentation php artisan digidocs:userdocs # User documentation php artisan digidocs:alldocs # Both types combined php artisan digidocs:watch # Watch mode for both types # 4. Multi-language generation php artisan digidocs:userdocs --lang=ja-JP # Japanese user docs php artisan digidocs:alldocs --lang=de-DE # German docs (both types) # 5. View statistics and costs php artisan digidocs:autodocs --stats --cost ``` 🧠 Intelligent Analysis Examples ------------------------------- [](#-intelligent-analysis-examples) **Developer documentation:** - ⏭️ **Private changes** β†’ Skipped (no significant changes) - βœ… **Public API changes** β†’ Generated documentation **User documentation:** - ⏭️ **Backend changes** β†’ Skipped (low user impact) - βœ… **UI/UX changes** β†’ Updated relevant sections πŸ“Š Documentation Quality ----------------------- [](#-documentation-quality) ### πŸ‘¨β€πŸ’» Developer Documentation [](#‍-developer-documentation) Generates comprehensive technical documentation with: - **File overview** and its purpose - **Complete API documentation** - all public methods and properties - **Laravel context** - relationships, scopes, middleware, etc. - **Practical usage examples** with working code - **Dependencies and relationships** - clear integration points ### πŸ‘₯ User Documentation [](#-user-documentation) Creates user-friendly application guides with: - **Application overview** - what the app does for users - **Feature sections** - organized by user workflows - **Step-by-step guides** - how to accomplish tasks - **Cross-referenced sections** - linked content organization - **User-focused language** - non-technical explanations πŸ“ Output Structure ------------------ [](#-output-structure) **Developer documentation:** ``` docs/code/ β”œβ”€β”€ Http/ β”‚ β”œβ”€β”€ Controllers/ β”‚ β”œβ”€β”€ Middleware/ β”‚ └── ... β”œβ”€β”€ Models/ β”œβ”€β”€ Services/ β”œβ”€β”€ config/ └── routes/ ``` **User documentation:** ``` docs/user/ β”œβ”€β”€ index.md # Main application guide └── sections/ β”œβ”€β”€ uΕΎivatelskΓ©-rozhranΓ­.md β”œβ”€β”€ navigace.md β”œβ”€β”€ formulΓ‘Ε™e.md β”œβ”€β”€ funkcionality.md └── ... ``` πŸ“ˆ Performance & Testing --------------------------- [](#-performance--testing) **Proven efficiency:** - ⚑ **56.5% skip rate** - Intelligent analysis avoids unnecessary regeneration - 🎯 **90.5% average confidence** - High-quality analysis decisions - πŸ’° **Cost-effective** - Only ~$0.26 for 350 API calls and 2M+ tokens - πŸš€ **Real-time processing** - Watch mode with instant Git commit detection **Comprehensive testing:** - βœ… **21 documented files** across Models, Controllers, Services, Middleware - βœ… **Complex commits** with multiple file types and changes - βœ… **Watch mode** tested with real-time Git monitoring - βœ… **Both documentation types** verified for quality and accuracy - βœ… **Cost tracking** validated for precise token and pricing calculations πŸ“‹ Changelog ----------- [](#-changelog) ### 🌍 v0.3.0 - Universal Language Support (2025-05-29) [](#-v030---universal-language-support-2025-05-29) **πŸ†• New Features:** - 🌍 **Universal ISO Language Support** - Any ISO language code now supported (cs-CZ, ja-JP, ar-SA, zh-CN, etc.) - πŸš€ **New `alldocs` Command** - Combined generation of both developer and user documentation - πŸ€– **AI-Powered Language Detection** - AI automatically recognizes and generates in specified language - πŸ”§ **Simplified Configuration** - No hardcoded languages, pure config-based language management **✨ Improvements:** - 🧹 **Removed 70+ hardcoded languages** from PHP code - now config-only - πŸ“ **Enhanced Language Instructions** - Simplified AI prompts for better language recognition - πŸ› οΈ **Fixed Memory System** - Added missing `remember()` and `search()` methods - πŸ”— **Updated Cross-Reference Manager** - Dynamic language support across all agents **πŸ§ͺ Testing:** - βœ… **Comprehensive Multi-Language Testing** - Czech, English, and Polish fully tested - βœ… **Memory System Validation** - SQLite database and vector storage verified - βœ… **17 Generated Documents** - 5 code docs + 12 user docs across multiple languages - βœ… **Zero-Config Language Addition** - New languages work instantly without code changes **πŸ“š Examples of Supported Languages:** - European: cs-CZ (Czech), en-US (English), de-DE (German), fr-FR (French) - Asian: ja-JP (Japanese), ko-KR (Korean), zh-CN (Chinese), hi-IN (Hindi) - Middle East: ar-SA (Arabic), he-IL (Hebrew), fa-IR (Persian) - African: sw-KE (Swahili), am-ET (Amharic), zu-ZA (Zulu) - **And many more - any ISO 639-1 + ISO 3166-1 combination!** ### v0.2.0 - User Documentation & Advanced Analysis (2025-05-27) [](#v020---user-documentation--advanced-analysis-2025-05-27) - Added UserDocumentationOrchestrator with complete user-focused documentation generation - Implemented UserChangeAnalysisAgent for user-impact analysis - Added comprehensive testing with 100% success rate across 24 test scenarios - Enhanced memory systems with RAG implementation ### v0.1.0 - Initial Release (2025-05-25) [](#v010---initial-release-2025-05-25) - Core DigiDocs functionality with AI-powered documentation generation - Developer documentation with intelligent change analysis - Git commit monitoring and real-time watch mode - Cost tracking and performance optimization ### Health Score 27 β€” LowBetter than 49% of packages Maintenance50 Moderate activity, may be stable Popularity3 Limited adoption so far Community6 Small or concentrated contributor base Maturity43 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits β€” single point of failure How is this calculated?**Maintenance (25%)** β€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** β€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** β€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** β€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~1 days Total 5 Last Release 354d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/a168730cffb93a2dad9217ba0f80c7d3ee7aafedf0eba144a558aff888b3fbb4?d=identicon)[karlost](/maintainers/karlost) --- Top Contributors [![karlost](https://avatars.githubusercontent.com/u/31898442?v=4)](https://github.com/karlost "karlost (3 commits)") --- Tags phplaraveldocumentationaigeneratorneuronaideveloper-docsuser-docsintelligent-analysis ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/karlost-digidocs/health.svg) ``` [![Health](https://phpackages.com/badges/karlost-digidocs/health.svg)](https://phpackages.com/packages/karlost-digidocs) ``` ### Alternatives [larastan/larastan Larastan - Discover bugs in your code without running it. A phpstan/phpstan extension for Laravel 6.4k43.5M5.2k](/packages/larastan-larastan)[spatie/laravel-enum Laravel Enum support 3655.4M31](/packages/spatie-laravel-enum)[psalm/plugin-laravel Psalm plugin for Laravel 3274.9M308](/packages/psalm-plugin-laravel)[laragear/preload Effortlessly make a Preload script for your Laravel application. 119363.5k](/packages/laragear-preload)[napp/xray-laravel AWS X-Ray for Laravel applications. 61407.3k](/packages/napp-xray-laravel)[aedart/athenaeum Athenaeum is a mono repository; a collection of various PHP packages 245.2k](/packages/aedart-athenaeum) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)