Merge pull request #124 from Grazulex/transfert-to-wiki

📚 Restructure documentation: Move to Wiki for better organization

Author: Grazulex

README.md

@@ -12,345 +12,92 @@ Generate modern, type-safe Data Transfer Objects (DTOs) in Laravel from clean YA
 [![Tests](https://img.shields.io/github/actions/workflow/status/grazulex/laravel-arc/tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/Grazulex/laravel-arc/actions)
 [![Code Style](https://img.shields.io/badge/code%20style-pint-000000?style=flat-square&logo=laravel)](https://github.com/laravel/pint)
 
-## 📖 Table of Contents
-
-- [Overview](#overview)
-- [✨ Features](#-features)
-- [📦 Installation](#-installation)
-- [🚀 Quick Start](#-quick-start)
-- [🎯 Traits System](#-traits-system)
-- [🔄 Field Transformers](#-field-transformers)
-- [📊 Export Formats](#-export-formats)
-- [⚙️ Configuration](#️-configuration)
-- [📚 Documentation](#-documentation)
-- [💡 Examples](#-examples)
-- [🧪 Testing](#-testing)
-- [🔧 Requirements](#-requirements)
-- [🚀 Performance](#-performance)
-- [🤝 Contributing](#-contributing)
-- [🔒 Security](#-security)
-- [📄 License](#-license)
-
 ## Overview
 
 Laravel Arc is a powerful Laravel package that simplifies Data Transfer Object (DTO) management through YAML-driven generation. Define your DTOs in simple YAML files and let Laravel Arc generate type-safe, validated PHP classes with automatic property access and comprehensive collection support.
 
 **Think of it as Laravel API Resources, but with stronger typing, automatic validation, and generated from YAML definitions.**
 
-### 🎯 Use Cases
-
-Laravel Arc is perfect for:
+### 🎯 Key Features
 
-- **API Development** - Type-safe request/response handling
-- **Data Validation** - Consistent validation across your application  
-- **Model Transformation** - Clean data layer separation
-- **Complex Forms** - Nested form validation and processing
-- **API Resources** - Alternative to Laravel Resources with stronger typing
+- **🏗️ YAML-Driven Generation** - Define DTOs in clean, readable YAML
+- **🔒 Type Safety** - Full PHP 8.3+ type enforcement with readonly properties
+- **✅ Automatic Validation** - Generate Laravel validation rules from field definitions
+- **🔄 Field Transformers** - Built-in data transformation (trim, slugify, normalize, etc.)
+- **📊 Export Formats** - Convert to JSON, XML, CSV, YAML, and more
+- **🎯 Behavioral Traits** - Timestamps, UUIDs, soft deletes, and tagging
+- **🚀 Modern PHP** - Leverages PHP 8.3+ features and best practices
 
-## ✨ Features
+### 📚 Complete Documentation
 
-- 🚀 **YAML-driven generation** - Define DTOs in simple, readable YAML files
-- 🔍 **Automatic validation** - Built-in Laravel validation rules support
-- 🏗️ **Rich field types** - 14+ field types including enums, UUIDs, nested DTOs, and JSON
-- 🔗 **Eloquent relationships** - Full support for Laravel relationship types
-- ⚡ **Direct property access** - Clean, modern syntax with PHP 8.3+ features
-- 📦 **Collection management** - Convert models to DTO collections like Laravel Resources
-- 🎯 **Powerful trait system** - Built-in behavioral traits for common functionality
-- 🔄 **Field transformers** - Automatically transform field values during DTO creation
-- 📤 **Multiple export formats** - Export DTOs in 10 formats
-- 🛠️ **Powerful CLI commands** - Generate, list, and manage DTOs from the command line
-- 📁 **Smart path resolution** - Automatic namespace-to-path conversion with custom organization
-- 🚨 **Enhanced error handling** - Detailed error messages with actionable suggestions
-- 📦 **Zero configuration** - Works out of the box with sensible defaults
-- 🧪 **Fully tested** - Comprehensive test suite with high coverage
+**➡️ [Visit the Wiki for complete documentation, examples, and guides](https://github.com/Grazulex/laravel-arc/wiki)**
 
-## 📦 Installation
+The wiki contains:
+- **[Getting Started Guide](https://github.com/Grazulex/laravel-arc/wiki/Getting-Started)**
+- **[Field Types & Transformers](https://github.com/Grazulex/laravel-arc/wiki/Field-Types)**
+- **[Advanced Features](https://github.com/Grazulex/laravel-arc/wiki/Advanced-Features)**
+- **[API Reference](https://github.com/Grazulex/laravel-arc/wiki/API-Reference)**
+- **[Examples & Recipes](https://github.com/Grazulex/laravel-arc/wiki/Examples)**
 
-Install the package via Composer:
+## 📦 Quick Installation
 
 ```bash
 composer require grazulex/laravel-arc
-```
-
-> **💡 Auto-Discovery**  
-> The service provider will be automatically registered thanks to Laravel's package auto-discovery.
-
-Publish configuration:
-
-```bash
-php artisan vendor:publish --tag=arc-config
+php artisan vendor:publish --provider="Grazulex\LaravelArc\LaravelArcServiceProvider"
 ```
 
 ## 🚀 Quick Start
 
-### 1. Create a DTO definition
-
+1. **Create a DTO definition:**
 ```bash
 php artisan dto:definition-init UserDTO --model=App\\Models\\User --table=users
 ```
 
-### 2. Define your DTO in YAML
-
-```yaml
-# dto-definitions/UserDTO.yaml
-header:
-  dto: UserDTO
-  namespace: App\DTO
-  model: App\Models\User
-  traits:
-    - HasTimestamps
-    - HasUuid
-
-fields:
-  name:
-    type: string
-    validation: [required, string, max:255]
-    transformers: [trim, title_case]
-  
-  email:
-    type: string
-    validation: [required, email]
-    transformers: [trim, lowercase]
-  
-  status:
-    type: string
-    default: "active"
-    validation: [required, in:active,inactive]
-```
-
-### 3. Generate your DTO
-
+2. **Generate the DTO class:**
 ```bash
-php artisan dto:generate UserDTO.yaml
+php artisan dto:generate user.yaml
 ```
 
-### 4. Use your DTO
-
+3. **Use your DTO:**
 ```php
-// Convert a model to DTO
-$user = User::find(1);
-$userDto = UserDTO::fromModel($user);
-
-// Convert a collection to DTO collection (like Laravel Resources)
-$users = User::all();
-$userDtos = UserDTO::collection($users); // Returns DtoCollection
-
-// API Resource format
-return response()->json($userDtos->toArrayResource());
-// Output: {"data": [{"id": 1, "name": "John", "email": "[email protected]", "status": "active"}]}
-
-// Export in multiple formats - 10 formats available
-$json = $userDto->toJson();
-$yaml = $userDto->toYaml();
-$csv = $userDto->toCsv();
-$xml = $userDto->toXml();
-
-// Validation
-$userDto = UserDTO::fromArray($request->all());
-if (!$userDto->isValid()) {
-    return response()->json(['errors' => $userDto->getErrors()], 422);
-}
-```
-
-## 🎯 Traits System
-
-Laravel Arc provides a powerful trait system with two types of traits:
+$userData = ['name' => 'John Doe', 'email' => '[email protected]'];
+$userDto = UserDTO::fromArray($userData);
 
-### Functional Traits (Automatic)
-
-Every DTO automatically includes these three powerful traits:
-
-- **ValidatesData** - Provides validation methods (`validate()`, `passes()`, `fails()`)
-- **ConvertsData** - Provides conversion methods (`toJson()`, `toCsv()`, `toXml()`, etc.)
-- **DtoUtilities** - Provides utility methods (`getProperties()`, `with()`, `equals()`)
-
-### Behavioral Traits (Optional) - 7 Available Traits
-
-Add specific functionality by including traits in your YAML definition:
-
-```yaml
-header:
-  traits:
-    - HasTimestamps    # Adds created_at, updated_at fields and methods
-    - HasUuid         # Adds id field with UUID validation
-    - HasSoftDeletes  # Adds deleted_at field for soft deletes
-    - HasVersioning   # Adds version field and versioning methods
-    - HasTagging      # Adds tags field and tagging methods
-    - HasAuditing     # Adds audit trail fields and methods
-    - HasCaching      # Adds caching capabilities
-```
-
-Example usage:
-
-```php
-// Using functional traits (automatic)
-$userDto = UserDTO::fromArray($data);
-if (UserDTO::passes($data)) {
-    $validated = UserDTO::validate($data);
-}
-
-// Using behavioral traits (if included)
-$userDto = $userDto->addTag('premium')
-                  ->nextVersion()
-                  ->touch()
-                  ->cache(3600);
-```
-
-## 🔄 Field Transformers
-
-Automatically transform field values during DTO creation:
-
-```yaml
-fields:
-  name:
-    type: string
-    transformers: [trim, title_case]  # "  john doe  " → "John Doe"
-  
-  email:
-    type: string
-    transformers: [trim, lowercase]   # "  [email protected]  " → "[email protected]"
-  
-  price:
-    type: decimal
-    transformers: [abs, clamp_min:0]  # -19.99 → 19.99
+echo $userDto->name; // 'John Doe'
+echo $userDto->toJson(); // JSON representation
 ```
 
-**Available transformers:**
-- **String transformers**: `trim`, `lowercase`, `uppercase`, `title_case`, `slugify`
-- **Numeric transformers**: `abs`, `clamp_max`, `clamp_min`
-- **Security transformers**: `encrypt`
-- **Phone transformers**: `normalize_phone` (adds +33 prefix for French numbers starting with 0)
+## 📖 Learn More
 
-## 📊 Export Formats
+- **[📚 Complete Documentation](https://github.com/Grazulex/laravel-arc/wiki)** - Full guides and API reference
+- **[🚀 Getting Started](https://github.com/Grazulex/laravel-arc/wiki/Getting-Started)** - Installation and first steps
+- **[💡 Examples](https://github.com/Grazulex/laravel-arc/wiki/Examples)** - Real-world usage examples
+- **[🔧 Advanced Features](https://github.com/Grazulex/laravel-arc/wiki/Advanced-Features)** - Transformers, traits, and more
 
-Export DTOs in 10 different formats:
-
-```php
-// Individual exports
-$json = $userDto->toJson();
-$yaml = $userDto->toYaml();
-$csv = $userDto->toCsv();
-$xml = $userDto->toXml();
-$toml = $userDto->toToml();
-$markdown = $userDto->toMarkdownTable();
-$phpArray = $userDto->toPhpArray();
-$queryString = $userDto->toQueryString();
-$messagepack = $userDto->toMessagePack();
-$collection = $userDto->toCollection();
-
-// Collection exports (with data wrapper like Laravel Resources)
-$jsonData = UserDTO::collectionToJson($users);
-$csvData = UserDTO::collectionToCsv($users);
-$xmlData = UserDTO::collectionToXml($users);
-$yamlData = UserDTO::collectionToYaml($users);
-$markdownData = UserDTO::collectionToMarkdownTable($users);
-```
-
-## ⚙️ Configuration
-
-Laravel Arc works out of the box, but you can customize it:
-
-```php
-// config/dto.php
-return [
-    'definitions_path' => base_path('database/dto_definitions'),
-    'output_path' => base_path('app/DTO'),
-];
-```
-
-## 📚 Documentation
-
-For complete documentation, examples, and advanced usage, please see:
-
-### Core Concepts
-- [📖 Documentation Index](docs/README.md) - Complete navigation guide
-- [🚀 Getting Started](docs/GETTING_STARTED.md) - Installation and first DTO
-- [📘 DTO Usage Guide](docs/DTO_USAGE_GUIDE.md) - How to use DTOs in your Laravel application
-- [YAML Schema](docs/YAML_SCHEMA.md) - Full YAML configuration reference
-- [Field Types](docs/FIELD_TYPES.md) - All available field types and options
-- [Traits Guide](docs/TRAITS_GUIDE.md) - Functional and behavioral traits system
-- [Validation Rules](docs/VALIDATION_RULES.md) - Custom validation and error handling
-
-### Advanced Features
-- [Collection Management](docs/COLLECTION_MANAGEMENT.md) - Working with DTO collections and API resources
-- [Export Formats](docs/EXPORT_FORMATS.md) - Export DTOs in 10 different formats
-- [Field Transformers](docs/FIELD_TRANSFORMERS.md) - Automatic field value transformation
-- [Relationships](docs/RELATIONSHIPS.md) - Eloquent relationships in DTOs
-- [Nested DTOs](docs/NESTED_DTO_GUIDE.md) - Building complex nested structures
-- [CLI Commands](docs/CLI_COMMANDS.md) - All available Artisan commands
-- [Advanced Usage](docs/ADVANCED_USAGE.md) - Advanced patterns and customizations
-
-## 💡 Examples
-
-Check out the [examples directory](examples) for complete working examples:
+## 🔧 Requirements
 
-- [🎯 Examples Collection](examples/README.md) - Working examples and templates
-- [Basic User DTO](examples/user.yaml) - Simple user DTO with validation
-- [API Controllers](examples/api-controller-example.php) - Using DTOs in API controllers
-- [Export Formats](examples/export-formats-example.php) - Export DTOs in 10 different formats
-- [Collection Methods](examples/collection-methods-example.php) - Advanced collection management
-- [Nested Structures](examples/nested-order.yaml) - Complex nested DTOs
-- [Enum Support](examples/enum-examples.yaml) - Working with PHP enums
+- **PHP:** ^8.3
+- **Laravel:** ^12.19
+- **Carbon:** ^3.10
 
 ## 🧪 Testing
 
-Laravel Arc includes comprehensive testing utilities:
-
-```php
-use Grazulex\LaravelArc\Testing\DtoTester;
-
-// Test DTO validation
-DtoTester::assertValidates($data, UserDTO::class);
-DtoTester::assertFailsValidation($data, UserDTO::class);
-
-// Test transformations
-DtoTester::assertTransforms($input, $expected, UserDTO::class);
-
-// Test collections
-DtoTester::assertCollection($models, UserDTO::class);
+```bash
+composer test
 ```
 
-## 🔧 Requirements
-
-- PHP: ^8.3
-- Laravel: ^12.19
-- Carbon: ^3.10
-
-## 🚀 Performance
-
-Laravel Arc is optimized for performance:
-
-- **Memory Efficient**: Minimal memory footprint with smart serialization
-- **Fast Generation**: Optimized YAML parsing and PHP generation
-- **Cached Definitions**: YAML definitions cached for better performance
-- **Bulk Operations**: Efficient handling of large model collections
-
 ## 🤝 Contributing
 
 We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
 
 ## 🔒 Security
 
-If you discover a security vulnerability, please review our [Security Policy](SECURITY.md) before disclosing it.
+Please review our [Security Policy](SECURITY.md) for reporting vulnerabilities.
 
 ## 📄 License
 
 Laravel Arc is open-sourced software licensed under the [MIT license](LICENSE.md).
 
 ---
 
-**Made with ❤️ for the Laravel community**
-
-### Resources
-
-- [📖 Documentation](docs/README.md)
-- [💬 Discussions](https://github.com/Grazulex/laravel-arc/discussions)
-- [🐛 Issue Tracker](https://github.com/Grazulex/laravel-arc/issues)
-- [📦 Packagist](https://packagist.org/packages/grazulex/laravel-arc)
-
-### Community Links
-
-- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) - Our code of conduct
-- [CONTRIBUTING.md](CONTRIBUTING.md) - How to contribute
-- [SECURITY.md](SECURITY.md) - Security policy
-- [RELEASES.md](RELEASES.md) - Release notes and changelog
+**Made with ❤️ by [Jean-Marc Strauven](https://github.com/Grazulex)**

composer.json

@@ -62,6 +62,7 @@
     "support": {
         "issues": "https://github.com/Grazulex/laravel-arc/issues",
         "source": "https://github.com/Grazulex/laravel-arc",
+        "docs": "https://github.com/Grazulex/laravel-arc/wiki",
         "wiki": "https://github.com/Grazulex/laravel-arc/wiki",
         "forum": "https://github.com/Grazulex/laravel-arc/discussions"
     },