Update documentation

Author: ManukMinasyan

CHANGELOG.md

@@ -1,15 +1,41 @@
 # Changelog
 
-All notable changes to `flowforge` will be documented in this file.
+All notable changes to this project will be documented in this file.
 
-## 0.1.4 - 2025-04-11
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-**Full Changelog**: https://github.com/Relaticle/flowforge/compare/0.1.3...0.1.4
+## [Unreleased]
 
-## 0.1.2 - 2025-04-04
+### Added
+- Enhanced developer experience with improved documentation
+- New QUICK-START.md guide for rapid onboarding
+- New DEVELOPMENT.md guide for contributors
+- Restructured README.md with better organization and examples
+- Model existence validation in generator command
+- Detailed troubleshooting section with common solutions
+- Comprehensive examples for all configuration options
+- Clear distinction between required and optional methods
+- Added read-only board implementation examples
+- Added separate stub files for create and edit actions
 
-**Full Changelog**: https://github.com/Relaticle/flowforge/compare/0.1.1...0.1.2
+### Changed
+- Completely redesigned code generation approach for true minimalism
+- Removed all PHPDocs from generated files for cleaner code
+- Radically simplified MakeKanbanBoardCommand to only ask for board name and model
+- Removed all interactive prompts for configuration options
+- Always generates a minimal read-only board as starting point
+- Reduced comments and unnecessary code in generated files
+- Enhanced stub templates for minimal, clean implementation
+- Reorganized documentation with clearer structure
+- Improved error messages and validation in code generator
+- Clarified that createAction() and editAction() methods are optional
+- Made generated code reflect the optional nature of interactive features
+- Simplified documentation for minimal implementation
+- Improved modularity by separating method templates into dedicated files
+- Adopted a true "convention over configuration" approach for better DX
 
-## 1.0.0 - 202X-XX-XX
+## [1.0.0] - 2023-04-XX
 
-- initial release
+### Added
+- Initial release

DEVELOPMENT.md

@@ -0,0 +1,177 @@
+# Flowforge Development Guide
+
+This document provides guidance for contributors looking to enhance or modify the Flowforge package.
+
+## 🏗️ Architecture Overview
+
+Flowforge follows a clean, modular architecture:
+
+### Core Components
+
+- **KanbanBoardPage**: Abstract Filament page class that serves as the foundation for boards
+- **KanbanBoard**: Livewire component that handles the UI and interactions
+- **KanbanConfig**: Immutable configuration class for board settings
+- **KanbanAdapterInterface**: Contract for data operations between models and the board
+
+### Adapters
+
+- **DefaultKanbanAdapter**: Standard implementation for Eloquent models
+- Custom adapters can be created for complex scenarios (e.g., custom fields, relationships)
+
+### Traits
+
+- **CardFormattingTrait**: Handles card display formatting
+- **CrudOperationsTrait**: Manages create, read, update, and delete operations
+- **QueryHandlingTrait**: Handles database queries and search functionality
+
+## 🧩 Directory Structure
+
+```
+src/
+├── Adapters/            # Data adapters for models/queries
+├── Commands/            # Artisan commands (MakeKanbanBoardCommand)
+├── Config/              # Configuration classes
+├── Concerns/            # Trait implementations
+├── Contracts/           # Interfaces (KanbanAdapterInterface)
+├── Enums/               # Enum classes
+├── Facades/             # Laravel facades
+├── Filament/            # Filament integration
+│   ├── Pages/           # KanbanBoardPage base class
+│   └── Resources/       # Filament resource integration 
+├── Livewire/            # Livewire components
+│   └── Components/      # KanbanBoard component
+├── Providers/           # Service providers
+├── Support/             # Helper classes
+└── Testing/             # Testing utilities
+```
+
+## 🚀 Development Environment Setup
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/relaticle/flowforge.git
+   cd flowforge
+   ```
+
+2. Install dependencies:
+   ```bash
+   composer install
+   npm install
+   ```
+
+3. Set up a Laravel test application (recommended):
+   ```bash
+   composer create-project laravel/laravel:^11.0 flowforge-test
+   cd flowforge-test
+   composer require filament/filament:^3.0
+   ```
+
+4. Link your local Flowforge development version:
+   ```bash
+   # In your flowforge-test composer.json, add:
+   "repositories": [
+       {
+           "type": "path",
+           "url": "../flowforge"
+       }
+   ]
+   ```
+
+5. Require the local package:
+   ```bash
+   composer require relaticle/flowforge:@dev
+   ```
+
+## 🧪 Testing
+
+Run the test suite:
+
+```bash
+composer test
+```
+
+Run specific test files:
+
+```bash
+composer test -- --filter=KanbanBoardTest
+```
+
+## 🔄 Development Workflow
+
+1. Create a new branch for your feature or fix:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. Make your changes, following the coding standards (PSR-12)
+
+3. Write or update tests to cover your changes
+
+4. Run the test suite to ensure all tests pass:
+   ```bash
+   composer test
+   ```
+
+5. Submit a pull request with a clear description of your changes
+
+## 📝 Coding Standards
+
+This package follows PSR-12 coding standards. You can check your code with:
+
+```bash
+composer lint
+```
+
+And automatically fix most issues with:
+
+```bash
+composer format
+```
+
+## 🔧 Common Development Tasks
+
+### Adding a New Configuration Option
+
+1. Add the property to `KanbanConfig` class
+2. Add a setter method in the `KanbanBoardPage` class
+3. Update the Livewire component to use the new configuration
+4. Add tests for the new feature
+5. Document the new option in README.md
+
+### Creating a New Command
+
+1. Create a new class in `src/Commands/` directory
+2. Register the command in `FlowforgeServiceProvider`
+3. Add tests for the command
+4. Document the command in README.md
+
+### Modifying the Kanban UI
+
+1. Locate the appropriate Livewire component in `src/Livewire/Components/`
+2. Make your changes to the component class or view
+3. Rebuild assets if necessary
+4. Test your changes in a real Laravel application
+5. Update documentation if the change affects user experience
+
+## 📚 Documentation Guidelines
+
+When updating or adding features, please also update:
+
+1. The main README.md file with usage examples
+2. PHPDoc comments in relevant classes
+3. This DEVELOPMENT.md file if architecture changes
+
+## 🤝 Getting Help
+
+If you have questions about development:
+
+1. Open an issue on GitHub
+2. Check existing issues and discussions
+3. Refer to the Filament documentation for UI component guidelines
+
+## 📋 Release Process
+
+1. Update the version number in `composer.json`
+2. Update CHANGELOG.md with the changes in the new version
+3. Create a new release on GitHub with release notes
+4. Tag the release with the appropriate version number