docs: consolidate documentation into organized structure

- Move 12 markdown files from root to docs/ subdirectories
- Organize documentation by category:
  • docs/troubleshooting/ (1 file)  - Technical troubleshooting guides
  • docs/deployment/      (4 files) - Deployment and security documentation
  • docs/guides/          (3 files) - Feature-specific guides
  • docs/planning/        (4 files) - Planning and improvement proposals

Root directory cleanup:
- Reduced from 16 to 4 markdown files in root
- Only essential project files remain:
  • CLAUDE.md (AI instructions)
  • README.md (Main project readme)
  • CLEANUP_PLAN.md (Current cleanup plan)
  • SRC_STRUCTURE_IMPROVEMENTS.md (Structure improvements)

This improves:
 Documentation discoverability
 Logical organization by purpose
 Clean root directory
 Better maintainability
This commit is contained in:
2025-10-05 11:05:04 +02:00
parent 887847dde6
commit 5050c7d73a
36686 changed files with 196456 additions and 12398919 deletions

View File

@@ -0,0 +1,53 @@
<?php
declare(strict_types=1);
namespace App\Framework\Admin\ValueObjects;
use App\Framework\Http\Method;
/**
* Admin Form Configuration
*
* Configuration for creating admin forms
*/
final readonly class AdminFormConfig
{
/**
* @param array<string, array{type: string, label: string, required?: bool, options?: array, placeholder?: string, help?: string}> $fields
* @param array<string, mixed> $data
*/
public function __construct(
public string $resource,
public string $action,
public Method $method,
public array $fields,
public array $data = [],
) {
}
public static function create(
string $resource,
string $action,
Method $method,
array $fields
): self {
return new self(
resource: $resource,
action: $action,
method: $method,
fields: $fields
);
}
public function withData(array $data): self
{
return new self(
resource: $this->resource,
action: $this->action,
method: $this->method,
fields: $this->fields,
data: [...$this->data, ...$data]
);
}
}

View File

@@ -0,0 +1,47 @@
<?php
declare(strict_types=1);
namespace App\Framework\Admin\ValueObjects;
/**
* Admin Table Configuration
*
* Configuration for creating admin data tables
*/
final readonly class AdminTableConfig
{
/**
* @param array<string, array{label: string, sortable?: bool, searchable?: bool, formatter?: string, class?: string}> $columns
*/
public function __construct(
public array $columns,
public string $resource,
public bool $sortable = true,
public bool $searchable = true,
public bool $paginated = true,
public int $perPage = 25,
public ?string $apiEndpoint = null,
) {
}
public static function create(
string $resource,
array $columns,
bool $sortable = true,
bool $searchable = true
): self {
return new self(
columns: $columns,
resource: $resource,
sortable: $sortable,
searchable: $searchable,
apiEndpoint: "/admin/api/{$resource}"
);
}
public function getApiEndpoint(): string
{
return $this->apiEndpoint ?? "/admin/api/{$this->resource}";
}
}

View File

@@ -0,0 +1,142 @@
<?php
declare(strict_types=1);
namespace App\Framework\Admin\ValueObjects;
/**
* CRUD Configuration Value Object
*
* Configuration for admin CRUD operations
*/
final readonly class CrudConfig
{
/**
* @param string $resource Resource name (e.g., 'campaigns', 'users')
* @param string $resourceName Singular display name (e.g., 'Campaign', 'User')
* @param string $title Page title
* @param array<string, mixed> $columns Column definitions for index view
* @param bool $canCreate Can create new items
* @param bool $canEdit Can edit items
* @param bool $canView Can view items
* @param bool $canDelete Can delete items
* @param array<string, mixed>|null $filters Filter definitions
* @param array<string, mixed>|null $bulkActions Bulk action definitions
* @param bool $searchable Enable search
*/
public function __construct(
public string $resource,
public string $resourceName,
public string $title,
public array $columns = [],
public bool $canCreate = true,
public bool $canEdit = true,
public bool $canView = true,
public bool $canDelete = true,
public ?array $filters = null,
public ?array $bulkActions = null,
public bool $searchable = true,
) {}
public static function forResource(
string $resource,
string $resourceName,
string $title
): self {
return new self(
resource: $resource,
resourceName: $resourceName,
title: $title
);
}
public function withColumns(array $columns): self
{
return new self(
resource: $this->resource,
resourceName: $this->resourceName,
title: $this->title,
columns: $columns,
canCreate: $this->canCreate,
canEdit: $this->canEdit,
canView: $this->canView,
canDelete: $this->canDelete,
filters: $this->filters,
bulkActions: $this->bulkActions,
searchable: $this->searchable
);
}
public function withPermissions(
bool $canCreate = true,
bool $canEdit = true,
bool $canView = true,
bool $canDelete = true
): self {
return new self(
resource: $this->resource,
resourceName: $this->resourceName,
title: $this->title,
columns: $this->columns,
canCreate: $canCreate,
canEdit: $canEdit,
canView: $canView,
canDelete: $canDelete,
filters: $this->filters,
bulkActions: $this->bulkActions,
searchable: $this->searchable
);
}
public function withFilters(array $filters): self
{
return new self(
resource: $this->resource,
resourceName: $this->resourceName,
title: $this->title,
columns: $this->columns,
canCreate: $this->canCreate,
canEdit: $this->canEdit,
canView: $this->canView,
canDelete: $this->canDelete,
filters: $filters,
bulkActions: $this->bulkActions,
searchable: $this->searchable
);
}
public function withBulkActions(array $bulkActions): self
{
return new self(
resource: $this->resource,
resourceName: $this->resourceName,
title: $this->title,
columns: $this->columns,
canCreate: $this->canCreate,
canEdit: $this->canEdit,
canView: $this->canView,
canDelete: $this->canDelete,
filters: $this->filters,
bulkActions: $bulkActions,
searchable: $this->searchable
);
}
public function toArray(): array
{
return [
'resource' => $this->resource,
'resourceName' => $this->resourceName,
'title' => $this->title,
'columns' => $this->columns,
'canCreate' => $this->canCreate,
'canEdit' => $this->canEdit,
'canView' => $this->canView,
'canDelete' => $this->canDelete,
'hasActions' => $this->canEdit || $this->canView || $this->canDelete,
'filters' => $this->filters,
'bulkActions' => $this->bulkActions,
'searchable' => $this->searchable,
];
}
}