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

@@ -3,6 +3,10 @@
declare(strict_types=1);
use App\Domain\Common\ValueObject\Email;
use App\Framework\Logging\ChannelLogger;
use App\Framework\Logging\LogChannel;
use App\Framework\Logging\LogLevel;
use App\Framework\Logging\ValueObjects\LogContext;
use App\Framework\Mail\Commands\SendEmailBatchCommand;
use App\Framework\Mail\Commands\SendEmailBatchCommandHandler;
use App\Framework\Mail\EmailList;
@@ -164,46 +168,51 @@ class BatchTestLogger implements \App\Framework\Logging\Logger
{
private array $logs = [];
public function emergency(string $message, array $context = []): void
public function emergency(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'emergency', 'message' => $message, 'context' => $context];
}
public function alert(string $message, array $context = []): void
public function alert(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'alert', 'message' => $message, 'context' => $context];
}
public function critical(string $message, array $context = []): void
public function critical(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'critical', 'message' => $message, 'context' => $context];
}
public function error(string $message, array $context = []): void
public function error(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'error', 'message' => $message, 'context' => $context];
}
public function warning(string $message, array $context = []): void
public function warning(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'warning', 'message' => $message, 'context' => $context];
}
public function notice(string $message, array $context = []): void
public function notice(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'notice', 'message' => $message, 'context' => $context];
}
public function info(string $message, array $context = []): void
public function info(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'info', 'message' => $message, 'context' => $context];
}
public function debug(string $message, array $context = []): void
public function debug(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'debug', 'message' => $message, 'context' => $context];
}
public function log(LogLevel $level, string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => $level->value, 'message' => $message, 'context' => $context];
}
public function getLogs(): array
{
return $this->logs;
@@ -239,6 +248,80 @@ class BatchTestLogger implements \App\Framework\Logging\Logger
return false;
}
public function logToChannel(LogChannel $channel, LogLevel $level, string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => $level->value, 'channel' => $channel->value, 'message' => $message, 'context' => $context];
}
private ?ChannelLogger $mockChannelLogger = null;
public ChannelLogger $security {
get {
return $this->mockChannelLogger ??= $this->createMockChannelLogger();
}
}
public ChannelLogger $cache {
get {
return $this->mockChannelLogger ??= $this->createMockChannelLogger();
}
}
public ChannelLogger $database {
get {
return $this->mockChannelLogger ??= $this->createMockChannelLogger();
}
}
public ChannelLogger $framework {
get {
return $this->mockChannelLogger ??= $this->createMockChannelLogger();
}
}
public ChannelLogger $error {
get {
return $this->mockChannelLogger ??= $this->createMockChannelLogger();
}
}
private function createMockChannelLogger(): ChannelLogger
{
return new class () implements ChannelLogger {
public function emergency(string $message, ?LogContext $context = null): void
{
}
public function alert(string $message, ?LogContext $context = null): void
{
}
public function critical(string $message, ?LogContext $context = null): void
{
}
public function error(string $message, ?LogContext $context = null): void
{
}
public function warning(string $message, ?LogContext $context = null): void
{
}
public function notice(string $message, ?LogContext $context = null): void
{
}
public function info(string $message, ?LogContext $context = null): void
{
}
public function debug(string $message, ?LogContext $context = null): void
{
}
};
}
}
// Test transport classes for batch handler

View File

@@ -3,7 +3,11 @@
declare(strict_types=1);
use App\Domain\Common\ValueObject\Email;
use App\Framework\Logging\ChannelLogger;
use App\Framework\Logging\LogChannel;
use App\Framework\Logging\Logger;
use App\Framework\Logging\LogLevel;
use App\Framework\Logging\ValueObjects\LogContext;
use App\Framework\Mail\Commands\SendEmailCommand;
use App\Framework\Mail\Commands\SendEmailCommandHandler;
use App\Framework\Mail\EmailList;
@@ -112,46 +116,51 @@ class MailTestLogger implements Logger
{
private array $logs = [];
public function emergency(string $message, array $context = []): void
public function emergency(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'emergency', 'message' => $message, 'context' => $context];
}
public function alert(string $message, array $context = []): void
public function alert(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'alert', 'message' => $message, 'context' => $context];
}
public function critical(string $message, array $context = []): void
public function critical(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'critical', 'message' => $message, 'context' => $context];
}
public function error(string $message, array $context = []): void
public function error(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'error', 'message' => $message, 'context' => $context];
}
public function warning(string $message, array $context = []): void
public function warning(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'warning', 'message' => $message, 'context' => $context];
}
public function notice(string $message, array $context = []): void
public function notice(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'notice', 'message' => $message, 'context' => $context];
}
public function info(string $message, array $context = []): void
public function info(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'info', 'message' => $message, 'context' => $context];
}
public function debug(string $message, array $context = []): void
public function debug(string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => 'debug', 'message' => $message, 'context' => $context];
}
public function log(LogLevel $level, string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => $level->value, 'message' => $message, 'context' => $context];
}
public function getLogs(): array
{
return $this->logs;
@@ -187,6 +196,80 @@ class MailTestLogger implements Logger
return false;
}
public function logToChannel(LogChannel $channel, LogLevel $level, string $message, ?LogContext $context = null): void
{
$this->logs[] = ['level' => $level->value, 'channel' => $channel->value, 'message' => $message, 'context' => $context];
}
private ?ChannelLogger $mockChannelLogger = null;
public ChannelLogger $security {
get {
return $this->mockChannelLogger ??= $this->createMockChannelLogger();
}
}
public ChannelLogger $cache {
get {
return $this->mockChannelLogger ??= $this->createMockChannelLogger();
}
}
public ChannelLogger $database {
get {
return $this->mockChannelLogger ??= $this->createMockChannelLogger();
}
}
public ChannelLogger $framework {
get {
return $this->mockChannelLogger ??= $this->createMockChannelLogger();
}
}
public ChannelLogger $error {
get {
return $this->mockChannelLogger ??= $this->createMockChannelLogger();
}
}
private function createMockChannelLogger(): ChannelLogger
{
return new class () implements ChannelLogger {
public function emergency(string $message, ?LogContext $context = null): void
{
}
public function alert(string $message, ?LogContext $context = null): void
{
}
public function critical(string $message, ?LogContext $context = null): void
{
}
public function error(string $message, ?LogContext $context = null): void
{
}
public function warning(string $message, ?LogContext $context = null): void
{
}
public function notice(string $message, ?LogContext $context = null): void
{
}
public function info(string $message, ?LogContext $context = null): void
{
}
public function debug(string $message, ?LogContext $context = null): void
{
}
};
}
}
// Test transport classes