Some checks failed
🚀 Build & Deploy Image / Determine Build Necessity (push) Failing after 10m14s
🚀 Build & Deploy Image / Build Runtime Base Image (push) Has been skipped
🚀 Build & Deploy Image / Build Docker Image (push) Has been skipped
🚀 Build & Deploy Image / Run Tests & Quality Checks (push) Has been skipped
🚀 Build & Deploy Image / Auto-deploy to Staging (push) Has been skipped
🚀 Build & Deploy Image / Auto-deploy to Production (push) Has been skipped
Security Vulnerability Scan / Check for Dependency Changes (push) Failing after 11m25s
Security Vulnerability Scan / Composer Security Audit (push) Has been cancelled
- Remove middleware reference from Gitea Traefik labels (caused routing issues) - Optimize Gitea connection pool settings (MAX_IDLE_CONNS=30, authentication_timeout=180s) - Add explicit service reference in Traefik labels - Fix intermittent 504 timeouts by improving PostgreSQL connection handling Fixes Gitea unreachability via git.michaelschiemer.de
732 lines
33 KiB
Markdown
732 lines
33 KiB
Markdown
# Markdown Files Analysis - Custom PHP Framework
|
|
|
|
**Generated:** $(date)
|
|
**Total Project Files:** 1579 (including dependencies)
|
|
**Relevant Files:** 513 (excluding node_modules, vendor, .git)
|
|
|
|
---
|
|
|
|
## Executive Summary
|
|
|
|
This analysis covers all markdown files in the Custom PHP Framework project, excluding third-party dependencies. The goal is to reorganize documentation from AI-specific `/docs/claude/` to general `/docs/` structure.
|
|
|
|
### Key Statistics
|
|
- **Total Markdown Files:** 513
|
|
- **Documentation Files:** ~100 (estimated, in /docs/)
|
|
- **Source Code Docs:** ~50 (README files in /src/)
|
|
- **Test Documentation:** ~20 (test strategy, examples)
|
|
- **Configuration Docs:** ~10 (deployment, docker, ansible)
|
|
- **Dependencies:** 1066 (node_modules + vendor - excluded)
|
|
|
|
---
|
|
|
|
## File Distribution by Directory
|
|
|
|
|
|
```
|
|
63 ./docs/claude
|
|
57 ./docs
|
|
48 ./docs/deployment
|
|
17 ./src/Framework/View/Processors/docs
|
|
15 ./backups/docs-backup-20250731125004
|
|
14 ./.claude/agents
|
|
13 ./docs/livecomponents
|
|
12 ./.gitea/workflows
|
|
11 ./docs/planning
|
|
9 .
|
|
7 ./docs/guides
|
|
6 ./src/Framework/LiveComponents/docs
|
|
6 ./deployment/docs/tests
|
|
6 ./backups/docs-backup-20250731125004/framework
|
|
5 ./tests/e2e/livecomponents
|
|
5 ./resources/js/docs
|
|
5 ./deployment/wireguard
|
|
5 ./deployment/docs/status
|
|
5 ./deployment/docs/guides
|
|
5 ./backups/docs-backup-20250731125004/framework/analytics
|
|
4 ./src/Framework/LiveComponents
|
|
4 ./docs/todo
|
|
4 ./docs/contributing
|
|
4 ./docs/components/waf
|
|
4 ./docs/components/security
|
|
4 ./docs/components/cryptography
|
|
4 ./docs/components/auth
|
|
4 ./backups/docs-backup-20250731125004/design-system
|
|
3 ./src/Framework/ReflectionLegacy
|
|
3 ./docs/roadmap
|
|
```
|
|
|
|
|
|
---
|
|
|
|
## Detailed File Listing by Category
|
|
|
|
### 1. Documentation Directory (/docs/)
|
|
|
|
- `./docs/admin-design-system.md` (479 lines)
|
|
- `./docs/ADMIN-FORM-FIELDS-DESIGN.md` (440 lines)
|
|
- `./docs/ADMIN-FORM-FIELDS-USAGE.md` (491 lines)
|
|
- `./docs/api/index.md` (838 lines)
|
|
- `./docs/api.md` (8 lines)
|
|
- `./docs/api-versioning-examples.md` (294 lines)
|
|
- `./docs/architecture/components.md` (528 lines)
|
|
- `./docs/ARCHITECTURE_IMPROVEMENTS.md` (1981 lines)
|
|
- `./docs/architecture/overview.md` (226 lines)
|
|
- `./docs/architecture/patterns.md` (1137 lines)
|
|
- `./docs/batch-api-examples.md` (236 lines)
|
|
- `./docs/cache-warming.md` (699 lines)
|
|
- `./docs/claude/animationsystem.md` (585 lines)
|
|
- `./docs/claude/architecture.md` (189 lines)
|
|
- `./docs/claude/async-components.md` (26 lines)
|
|
- `./docs/claude/chips-cookies.md` (465 lines)
|
|
- `./docs/claude/common-workflows.md` (1259 lines)
|
|
- `./docs/claude/configuration-best-practices.md` (297 lines)
|
|
- `./docs/claude/console-commands.md` (30 lines)
|
|
- `./docs/claude/curl-oop-api.md` (996 lines)
|
|
- `./docs/claude/database-patterns.md` (1526 lines)
|
|
- `./docs/claude/deployment-architecture.md` (777 lines)
|
|
- `./docs/claude/development-commands.md` (157 lines)
|
|
- `./docs/claude/error-handling.md` (644 lines)
|
|
- `./docs/claude/event-system.md` (963 lines)
|
|
- `./docs/claude/examples/migrations/SafeVsUnsafeMigrations.md` (420 lines)
|
|
- `./docs/claude/exception-system-advanced-features.md` (754 lines)
|
|
- `./docs/claude/filesystem-patterns.md` (965 lines)
|
|
- `./docs/claude/framework-personas.md` (766 lines)
|
|
- `./docs/claude/framework-refactoring-recommendations.md` (748 lines)
|
|
- `./docs/claude/guidelines.md` (882 lines)
|
|
- `./docs/claude/livecomponent-file-uploads.md` (893 lines)
|
|
- `./docs/claude/livecomponent-formbuilder-usage.md` (458 lines)
|
|
- `./docs/claude/livecomponent-lazy-loading.md` (681 lines)
|
|
- `./docs/claude/livecomponent-lifecycle-hooks.md` (572 lines)
|
|
- `./docs/claude/livecomponent-nested-components.md` (717 lines)
|
|
- `./docs/claude/livecomponents-best-practices.md` (461 lines)
|
|
- `./docs/claude/livecomponents-caching-system.md` (683 lines)
|
|
- `./docs/claude/livecomponents-dom-badges.md` (236 lines)
|
|
- `./docs/claude/livecomponent-security.md` (223 lines)
|
|
- `./docs/claude/livecomponents-implementation-plan.md` (699 lines)
|
|
- `./docs/claude/livecomponents-lazy-loading.md` (717 lines)
|
|
- `./docs/claude/livecomponent-slot-system.md` (1127 lines)
|
|
- `./docs/claude/livecomponents-monitoring-debugging.md` (701 lines)
|
|
- `./docs/claude/livecomponents-observability.md` (540 lines)
|
|
- `./docs/claude/livecomponents-performance-optimizations.md` (725 lines)
|
|
- `./docs/claude/livecomponents-playground.md` (1108 lines)
|
|
- `./docs/claude/livecomponents-roadmap.md` (1027 lines)
|
|
- `./docs/claude/livecomponents-system.md` (552 lines)
|
|
- `./docs/claude/livecomponents-test-harness.md` (504 lines)
|
|
- `./docs/claude/magiclinks-system.md` (807 lines)
|
|
- `./docs/claude/mcp-integration.md` (260 lines)
|
|
- `./docs/claude/migration-system-quick-reference.md` (202 lines)
|
|
- `./docs/claude/ml-framework-architecture.md` (593 lines)
|
|
- `./docs/claude/naming-conventions.md` (832 lines)
|
|
- `./docs/claude/performance-monitoring.md` (30 lines)
|
|
- `./docs/claude/performance-profiling.md` (857 lines)
|
|
- `./docs/claude/php85-framework-integration.md` (550 lines)
|
|
- `./docs/claude/posix-system.md` (1316 lines)
|
|
- `./docs/claude/postgresql-features.md` (1127 lines)
|
|
- `./docs/claude/queue-system.md` (1135 lines)
|
|
- `./docs/claude/route-authorization.md` (291 lines)
|
|
- `./docs/claude/routing-value-objects.md` (305 lines)
|
|
- `./docs/claude/scheduler-queue-pipeline.md` (458 lines)
|
|
- `./docs/claude/scheduler-queue-pipeline-persona.md` (273 lines)
|
|
- `./docs/claude/security-patterns.md` (1135 lines)
|
|
- `./docs/claude/sockets-module.md` (671 lines)
|
|
- `./docs/claude/sse-integration-guide.md` (978 lines)
|
|
- `./docs/claude/sse-system.md` (1068 lines)
|
|
- `./docs/claude/structured-logging.md` (577 lines)
|
|
- `./docs/claude/troubleshooting.md` (1074 lines)
|
|
- `./docs/claude/typed-string-system.md` (1141 lines)
|
|
- `./docs/claude/view-caching-system.md` (716 lines)
|
|
- `./docs/claude/view-refactoring-plan.md` (614 lines)
|
|
- `./docs/claude/xcomponent-processor.md` (764 lines)
|
|
- `./docs/claude/x-component-syntax.md` (335 lines)
|
|
- `./docs/components/analytics/configuration.md` (477 lines)
|
|
- `./docs/components/analytics/examples.md` (760 lines)
|
|
- `./docs/components/analytics/index.md` (507 lines)
|
|
- `./docs/components/auth/configuration.md` (429 lines)
|
|
- `./docs/components/auth/examples.md` (796 lines)
|
|
- `./docs/components/auth/index.md` (309 lines)
|
|
- `./docs/components/auth/security.md` (903 lines)
|
|
- `./docs/components/cryptography/configuration.md` (396 lines)
|
|
- `./docs/components/cryptography/examples.md` (702 lines)
|
|
- `./docs/components/cryptography/index.md` (364 lines)
|
|
- `./docs/components/cryptography/security.md` (727 lines)
|
|
- `./docs/components/security/csrf-protection.md` (417 lines)
|
|
- `./docs/components/security/index.md` (363 lines)
|
|
- `./docs/components/security/request-signing.md` (410 lines)
|
|
- `./docs/components/security/security-headers.md` (382 lines)
|
|
- `./docs/components/validation/examples.md` (424 lines)
|
|
- `./docs/components/validation/index.md` (338 lines)
|
|
- `./docs/components/validation/rules.md` (451 lines)
|
|
- `./docs/components/waf/configuration.md` (279 lines)
|
|
- `./docs/components/waf/feedback.md` (280 lines)
|
|
- `./docs/components/waf/index.md` (135 lines)
|
|
- `./docs/components/waf/machine-learning.md` (252 lines)
|
|
- `./docs/console-best-practices.md` (486 lines)
|
|
- `./docs/console-dialog-mode.md` (472 lines)
|
|
- `./docs/console-optional-parameters.md` (422 lines)
|
|
- `./docs/contributing/code-style.md` (598 lines)
|
|
- `./docs/contributing/documentation.md` (345 lines)
|
|
- `./docs/contributing/git-hooks.md` (151 lines)
|
|
- `./docs/contributing/pull-requests.md` (334 lines)
|
|
- `./docs/database-migration-fix.md` (78 lines)
|
|
- `./docs/database-module-migration-analysis.md` (413 lines)
|
|
- `./docs/database/new-features.md` (329 lines)
|
|
- `./docs/DefaultImplementation-Attribute.md` (447 lines)
|
|
- `./docs/dependency-scanning.md` (401 lines)
|
|
- `./docs/deployment/ANSIBLE_DEPLOYMENT.md` (969 lines)
|
|
- `./docs/deployment/AUTOSSH-SETUP-COMPLETED.md` (243 lines)
|
|
- `./docs/deployment/AUTOSSH-SETUP.md` (428 lines)
|
|
- `./docs/deployment/cache-configuration.md` (244 lines)
|
|
- `./docs/deployment/cache-permissions-quick-fix.md` (74 lines)
|
|
- `./docs/deployment/database-migration-strategy.md` (775 lines)
|
|
- `./docs/deployment/deployment-automation.md` (816 lines)
|
|
- `./docs/deployment/env-production-template.md` (407 lines)
|
|
- `./docs/deployment/gitea-secrets-setup.md` (297 lines)
|
|
- `./docs/deployment/GRAFANA-VPN-ACCESS.md` (108 lines)
|
|
- `./docs/deployment/GRAFANA-VPN-NEXT-STEPS.md` (125 lines)
|
|
- `./docs/deployment/GRAFANA-VPN-SECURITY-PLAN.md` (149 lines)
|
|
- `./docs/deployment/local-secrets-unification-plan.md` (470 lines)
|
|
- `./docs/deployment/local-stack-restructure-plan.md` (359 lines)
|
|
- `./docs/deployment/logging-configuration.md` (715 lines)
|
|
- `./docs/deployment/production-compose-consolidation-plan.md` (262 lines)
|
|
- `./docs/deployment/production-logging.md` (601 lines)
|
|
- `./docs/deployment/production-prerequisites.md` (340 lines)
|
|
- `./docs/deployment/PRODUCTION-SECURITY-UPDATES.md` (133 lines)
|
|
- `./docs/deployment/README.md` (67 lines)
|
|
- `./docs/deployment/secrets-management.md` (614 lines)
|
|
- `./docs/deployment/shared-postgres-override-plan.md` (303 lines)
|
|
- `./docs/deployment/SSH-MAKEFILE-COMMANDS.md` (319 lines)
|
|
- `./docs/deployment/SSL-PRODUCTION-SETUP.md` (194 lines)
|
|
- `./docs/deployment/ssl-setup.md` (540 lines)
|
|
- `./docs/deployment/staging-database-connection-analysis.md` (185 lines)
|
|
- `./docs/deployment/staging-postgres-connection-plan.md` (209 lines)
|
|
- `./docs/deployment/test-registry-credentials.md` (197 lines)
|
|
- `./docs/deployment/VPN-ROUTING-CLIENT-CHECK.md` (195 lines)
|
|
- `./docs/deployment/VPN-ROUTING-FINAL-FIX.md` (91 lines)
|
|
- `./docs/deployment/VPN-ROUTING-FIX-DETAILED.md` (100 lines)
|
|
- `./docs/deployment/VPN-ROUTING-FIX-GUIDE.md` (143 lines)
|
|
- `./docs/deployment/VPN-ROUTING-FIX.md` (120 lines)
|
|
- `./docs/deployment/VPN-ROUTING-PROBLEM-ANALYSIS.md` (120 lines)
|
|
- `./docs/deployment/WIREGUARD-DNS-FIX-IMPLEMENTED.md` (283 lines)
|
|
- `./docs/deployment/WIREGUARD-FUTURE-SECURITY.md` (243 lines)
|
|
- `./docs/deployment/WIREGUARD-IMPLEMENTATION-PLAN.md` (1175 lines)
|
|
- `./docs/deployment/WIREGUARD-NEW-CONFIG-READY.md` (123 lines)
|
|
- `./docs/deployment/WIREGUARD-RECREATE-AND-TEST.md` (176 lines)
|
|
- `./docs/deployment/WIREGUARD-SETUP.md` (595 lines)
|
|
- `./docs/deployment/WIREGUARD-WINDOWS-CONFIG-EXAMPLE.md` (48 lines)
|
|
- `./docs/deployment/WIREGUARD-WINDOWS-DNS-FIX.md` (141 lines)
|
|
- `./docs/deployment/WIREGUARD-WINDOWS-DNS-PRIORITY-FIX.md` (108 lines)
|
|
- `./docs/deployment/WIREGUARD-WINDOWS-FIREWALL-CHECK.md` (186 lines)
|
|
- `./docs/deployment/WIREGUARD-WINDOWS-INTERFACE-METRIC-FIX.md` (63 lines)
|
|
- `./docs/deployment/WIREGUARD-WINDOWS-ROUTE-FIX.md` (103 lines)
|
|
- `./docs/deployment/WIREGUARD-WINDOWS-ROUTE-GATEWAY-FIX.md` (176 lines)
|
|
- `./docs/deployment/WIREGUARD-WINDOWS-ROUTING-FINAL-ANALYSIS.md` (109 lines)
|
|
- `./docs/design-token-system.md` (374 lines)
|
|
- `./docs/error-handler-enhancements.md` (615 lines)
|
|
- `./docs/ERROR-HANDLING-AUDIT-REPORT.md` (708 lines)
|
|
- `./docs/ERROR-HANDLING-MIGRATION-PLAN.md` (3319 lines)
|
|
- `./docs/ERROR-HANDLING-UNIFIED-ARCHITECTURE.md` (1766 lines)
|
|
- `./docs/ERROR-RENDERER-IMPROVEMENTS-PLAN.md` (274 lines)
|
|
- `./docs/ERROR-RENDERER-REFACTORING-PLAN.md` (199 lines)
|
|
- `./docs/examples/poll-system-usage.md` (609 lines)
|
|
- `./docs/exception-hierarchy-pattern.md` (684 lines)
|
|
- `./docs/exception-migration-guide.md` (1132 lines)
|
|
- `./docs/FILECACHE_PERMISSION_FIX_PLAN.md` (217 lines)
|
|
- `./docs/FILEPERMISSION_EXCEPTION_IMPROVEMENT_PLAN.md` (226 lines)
|
|
- `./docs/FORPROCESSOR-FIX-SUMMARY.md` (190 lines)
|
|
- `./docs/FORPROCESSOR-ISSUE-ANALYSIS.md` (106 lines)
|
|
- `./docs/FRAMEWORK-IMPROVEMENT-PROPOSALS.md` (591 lines)
|
|
- `./docs/FRAMEWORK_IMPROVEMENTS_ROADMAP.md` (173 lines)
|
|
- `./docs/getting-started/configuration.md` (214 lines)
|
|
- `./docs/getting-started/first-steps.md` (327 lines)
|
|
- `./docs/getting-started/installation.md` (108 lines)
|
|
- `./docs/gitea-actions-setup.md` (383 lines)
|
|
- `./docs/graphql-examples.md` (386 lines)
|
|
- `./docs/guides/controllers.md` (727 lines)
|
|
- `./docs/guides/README-image-upload.md` (128 lines)
|
|
- `./docs/guides/README-static-site.md` (118 lines)
|
|
- `./docs/guides/README-websocket.md` (118 lines)
|
|
- `./docs/guides/routing.md` (370 lines)
|
|
- `./docs/guides/security.md` (585 lines)
|
|
- `./docs/guides/validation.md` (539 lines)
|
|
- `./docs/implementations/queue-job-anomaly-detection.md` (634 lines)
|
|
- `./docs/job-dashboard.md` (733 lines)
|
|
- `./docs/livecomponents/01-getting-started.md` (520 lines)
|
|
- `./docs/livecomponents/advanced-features.md` (1027 lines)
|
|
- `./docs/livecomponents/api-reference.md` (1331 lines)
|
|
- `./docs/livecomponents/attributes-reference.md` (1380 lines)
|
|
- `./docs/livecomponents/best-practices.md` (1014 lines)
|
|
- `./docs/livecomponents/events-reference.md` (1354 lines)
|
|
- `./docs/livecomponents/faq.md` (864 lines)
|
|
- `./docs/livecomponents/LIVECOMPONENTS-COMPLETE-SUMMARY.md` (681 lines)
|
|
- `./docs/livecomponents/performance-guide.md` (1003 lines)
|
|
- `./docs/livecomponents/PHASE-5-COMPLETION.md` (597 lines)
|
|
- `./docs/livecomponents/README.md` (257 lines)
|
|
- `./docs/livecomponents/security-guide.md` (691 lines)
|
|
- `./docs/livecomponents/troubleshooting.md` (978 lines)
|
|
- `./docs/livecomponents-type-safety-refactoring.md` (400 lines)
|
|
- `./docs/logging/best-practices.md` (837 lines)
|
|
- `./docs/logging/docker-json-logging.md` (373 lines)
|
|
- `./docs/logging/log-health-check-command.md` (162 lines)
|
|
- `./docs/logging-module.md` (185 lines)
|
|
- `./docs/Makefile.md` (66 lines)
|
|
- `./docs/middleware-robustness.md` (130 lines)
|
|
- `./docs/migration/ErrorHandling-to-ExceptionHandling-Strategy.md` (798 lines)
|
|
- `./docs/ml-model-management-deployment.md` (807 lines)
|
|
- `./docs/ml-model-management.md` (872 lines)
|
|
- `./docs/next-steps.md` (67 lines)
|
|
- `./docs/n-plus-one-detection.md` (749 lines)
|
|
- `./docs/performance/filesystem-optimization-analysis.md` (284 lines)
|
|
- `./docs/performance/filesystem-phase1-optimizations-implemented.md` (367 lines)
|
|
- `./docs/performance/index-optimization.md` (559 lines)
|
|
- `./docs/PERMISSIONS.md` (226 lines)
|
|
- `./docs/plan.md` (252 lines)
|
|
- `./docs/planning/ADMIN_AUTH_SECURITY_ENHANCEMENT.md` (140 lines)
|
|
- `./docs/planning/CURRENT_SPRINT.md` (178 lines)
|
|
- `./docs/planning/docs-implementation-plan.md` (163 lines)
|
|
- `./docs/planning/docs-replacement-recommendation.md` (137 lines)
|
|
- `./docs/planning/documentation-update-proposal.md` (138 lines)
|
|
- `./docs/planning/ML-WAF-Behavioral-Analysis-Implementation-Summary.md` (565 lines)
|
|
- `./docs/planning/N+1-Detection-ML-Implementation-Summary.md` (263 lines)
|
|
- `./docs/planning/N+1-Detection-ML-Integration-Summary.md` (402 lines)
|
|
- `./docs/planning/N+1-Detection-ML-Next-Steps.md` (1154 lines)
|
|
- `./docs/planning/SECURITY_AUDIT_REPORT.md` (1059 lines)
|
|
- `./docs/planning/TODO.md` (425 lines)
|
|
- `./docs/PRESAVE-USAGE-GUIDE.md` (458 lines)
|
|
- `./docs/quality/code-quality-scanner.md` (112 lines)
|
|
- `./docs/queue-deployment.md` (631 lines)
|
|
- `./docs/README.md` (68 lines)
|
|
- `./docs/REDIS_ACL_EXPLANATION.md` (388 lines)
|
|
- `./docs/REDIS_AUTHENTICATION_ANALYSIS.md` (364 lines)
|
|
- `./docs/refactoring/mcp-module-refactoring-plan.md` (346 lines)
|
|
- `./docs/refactoring/phase-1-completion-report.md` (213 lines)
|
|
- `./docs/refactoring/phase-2-completion-report.md` (324 lines)
|
|
- `./docs/roadmap/features.md` (83 lines)
|
|
- `./docs/roadmap/milestones.md` (289 lines)
|
|
- `./docs/roadmap/tasks.md` (138 lines)
|
|
- `./docs/search-api-examples.md` (471 lines)
|
|
- `./docs/search-external-mapping-examples.md` (255 lines)
|
|
- `./docs/spa-router-backend-integration.md` (125 lines)
|
|
- `./docs/sqlstate-integration-design.md` (777 lines)
|
|
- `./docs/SSL_DEPLOYMENT.md` (371 lines)
|
|
- `./docs/tasks.md` (153 lines)
|
|
- `./docs/TEMPLATE-SYSTEM-ANALYSIS.md` (386 lines)
|
|
- `./docs/todo/css-generation-system.md` (293 lines)
|
|
- `./docs/todo/design-system-improvements.md` (263 lines)
|
|
- `./docs/todo/design-token-system-future-features.md` (318 lines)
|
|
- `./docs/todo/README.md` (68 lines)
|
|
- `./docs/troubleshooting/AUTOLOADER_WORKAROUND.md` (67 lines)
|
|
- `./docs/vault-system.md` (401 lines)
|
|
- `./docs/whatsapp-notification-channel.md` (438 lines)
|
|
|
|
### 2. Claude-Specific Documentation (/docs/claude/)
|
|
|
|
- `./docs/claude/animationsystem.md` (585 lines)
|
|
- `./docs/claude/architecture.md` (189 lines)
|
|
- `./docs/claude/async-components.md` (26 lines)
|
|
- `./docs/claude/chips-cookies.md` (465 lines)
|
|
- `./docs/claude/common-workflows.md` (1259 lines)
|
|
- `./docs/claude/configuration-best-practices.md` (297 lines)
|
|
- `./docs/claude/console-commands.md` (30 lines)
|
|
- `./docs/claude/curl-oop-api.md` (996 lines)
|
|
- `./docs/claude/database-patterns.md` (1526 lines)
|
|
- `./docs/claude/deployment-architecture.md` (777 lines)
|
|
- `./docs/claude/development-commands.md` (157 lines)
|
|
- `./docs/claude/error-handling.md` (644 lines)
|
|
- `./docs/claude/event-system.md` (963 lines)
|
|
- `./docs/claude/examples/migrations/SafeVsUnsafeMigrations.md` (420 lines)
|
|
- `./docs/claude/exception-system-advanced-features.md` (754 lines)
|
|
- `./docs/claude/filesystem-patterns.md` (965 lines)
|
|
- `./docs/claude/framework-personas.md` (766 lines)
|
|
- `./docs/claude/framework-refactoring-recommendations.md` (748 lines)
|
|
- `./docs/claude/guidelines.md` (882 lines)
|
|
- `./docs/claude/livecomponent-file-uploads.md` (893 lines)
|
|
- `./docs/claude/livecomponent-formbuilder-usage.md` (458 lines)
|
|
- `./docs/claude/livecomponent-lazy-loading.md` (681 lines)
|
|
- `./docs/claude/livecomponent-lifecycle-hooks.md` (572 lines)
|
|
- `./docs/claude/livecomponent-nested-components.md` (717 lines)
|
|
- `./docs/claude/livecomponents-best-practices.md` (461 lines)
|
|
- `./docs/claude/livecomponents-caching-system.md` (683 lines)
|
|
- `./docs/claude/livecomponents-dom-badges.md` (236 lines)
|
|
- `./docs/claude/livecomponent-security.md` (223 lines)
|
|
- `./docs/claude/livecomponents-implementation-plan.md` (699 lines)
|
|
- `./docs/claude/livecomponents-lazy-loading.md` (717 lines)
|
|
- `./docs/claude/livecomponent-slot-system.md` (1127 lines)
|
|
- `./docs/claude/livecomponents-monitoring-debugging.md` (701 lines)
|
|
- `./docs/claude/livecomponents-observability.md` (540 lines)
|
|
- `./docs/claude/livecomponents-performance-optimizations.md` (725 lines)
|
|
- `./docs/claude/livecomponents-playground.md` (1108 lines)
|
|
- `./docs/claude/livecomponents-roadmap.md` (1027 lines)
|
|
- `./docs/claude/livecomponents-system.md` (552 lines)
|
|
- `./docs/claude/livecomponents-test-harness.md` (504 lines)
|
|
- `./docs/claude/magiclinks-system.md` (807 lines)
|
|
- `./docs/claude/mcp-integration.md` (260 lines)
|
|
- `./docs/claude/migration-system-quick-reference.md` (202 lines)
|
|
- `./docs/claude/ml-framework-architecture.md` (593 lines)
|
|
- `./docs/claude/naming-conventions.md` (832 lines)
|
|
- `./docs/claude/performance-monitoring.md` (30 lines)
|
|
- `./docs/claude/performance-profiling.md` (857 lines)
|
|
- `./docs/claude/php85-framework-integration.md` (550 lines)
|
|
- `./docs/claude/posix-system.md` (1316 lines)
|
|
- `./docs/claude/postgresql-features.md` (1127 lines)
|
|
- `./docs/claude/queue-system.md` (1135 lines)
|
|
- `./docs/claude/route-authorization.md` (291 lines)
|
|
- `./docs/claude/routing-value-objects.md` (305 lines)
|
|
- `./docs/claude/scheduler-queue-pipeline.md` (458 lines)
|
|
- `./docs/claude/scheduler-queue-pipeline-persona.md` (273 lines)
|
|
- `./docs/claude/security-patterns.md` (1135 lines)
|
|
- `./docs/claude/sockets-module.md` (671 lines)
|
|
- `./docs/claude/sse-integration-guide.md` (978 lines)
|
|
- `./docs/claude/sse-system.md` (1068 lines)
|
|
- `./docs/claude/structured-logging.md` (577 lines)
|
|
- `./docs/claude/troubleshooting.md` (1074 lines)
|
|
- `./docs/claude/typed-string-system.md` (1141 lines)
|
|
- `./docs/claude/view-caching-system.md` (716 lines)
|
|
- `./docs/claude/view-refactoring-plan.md` (614 lines)
|
|
- `./docs/claude/xcomponent-processor.md` (764 lines)
|
|
- `./docs/claude/x-component-syntax.md` (335 lines)
|
|
|
|
### 3. Root Directory Documentation
|
|
|
|
- `./AGENTS.md` (432 lines)
|
|
- `./CLAUDE.md` (292 lines)
|
|
- `./CLEANUP_PLAN.md` (186 lines)
|
|
- `./DEPLOYMENT_FIX.md` (22 lines)
|
|
- `./ENV_SETUP.md` (266 lines)
|
|
- `./LIVECOMPONENTS_TEST.md` (160 lines)
|
|
- `./README.md` (322 lines)
|
|
- `./SRC_STRUCTURE_IMPROVEMENTS.md` (368 lines)
|
|
- `./todo.md` (585 lines)
|
|
|
|
### 4. Source Code Documentation
|
|
|
|
- `./src/Application/Controllers/Test/README.md` (188 lines)
|
|
- `./src/Application/LiveComponents/UserRegistration/README.md` (213 lines)
|
|
- `./src/Domain/Asset/README.md` (526 lines)
|
|
- `./src/Domain/Cms/README.md` (193 lines)
|
|
- `./src/Domain/Media/README.md` (92 lines)
|
|
- `./src/Domain/Meta/README.md` (18 lines)
|
|
- `./src/Domain/PreSave/README.md` (629 lines)
|
|
- `./src/Framework/Admin/README.md` (691 lines)
|
|
- `./src/Framework/Analytics/README.md` (342 lines)
|
|
- `./src/Framework/AsyncExamples/README.md` (58 lines)
|
|
- `./src/Framework/Cache/README.md` (338 lines)
|
|
- `./src/Framework/CircuitBreaker/README.md` (210 lines)
|
|
- `./src/Framework/Console/README.md` (131 lines)
|
|
- `./src/Framework/Core/DOKUMENTATION.md` (45 lines)
|
|
- `./src/Framework/Core/ImplementationLocator.md` (17 lines)
|
|
- `./src/Framework/Core/ValueObjects/README.md` (334 lines)
|
|
- `./src/Framework/Database/Example/README.md` (69 lines)
|
|
- `./src/Framework/Database/README.md` (21 lines)
|
|
- `./src/Framework/Database/TODO.md` (92 lines)
|
|
- `./src/Framework/DDoS/README.md` (133 lines)
|
|
- `./src/Framework/DDoS/REFACTORING-SUMMARY.md` (130 lines)
|
|
- `./src/Framework/Debug/readme.md` (104 lines)
|
|
- `./src/Framework/DI/DOKUMENTATION.md` (90 lines)
|
|
- `./src/Framework/Discovery/README.md` (184 lines)
|
|
- `./src/Framework/Display/README.md` (583 lines)
|
|
- `./src/Framework/ErrorBoundaries/Async/README.md` (265 lines)
|
|
- `./src/Framework/ErrorBoundaries/Middleware/README.md` (222 lines)
|
|
- `./src/Framework/EventSourcing/Projections/README.md` (394 lines)
|
|
- `./src/Framework/EventSourcing/Replay/README.md` (1035 lines)
|
|
- `./src/Framework/EventSourcing/Sagas/README.md` (863 lines)
|
|
- `./src/Framework/EventSourcing/Snapshots/README.md` (703 lines)
|
|
- `./src/Framework/Exception/InErrorHandler.md` (22 lines)
|
|
- `./src/Framework/Filesystem/README.md` (68 lines)
|
|
- `./src/Framework/Http/DOKUMENTATION.md` (92 lines)
|
|
- `./src/Framework/Http/Middlewares/REFACTORING-SUMMARY.md` (144 lines)
|
|
- `./src/Framework/Http/Url.php85/README.md` (373 lines)
|
|
- `./src/Framework/Http/Url/README.md` (373 lines)
|
|
- `./src/Framework/LiveComponents/Cache/README.md` (352 lines)
|
|
- `./src/Framework/LiveComponents/docs/API-REFERENCE.md` (1369 lines)
|
|
- `./src/Framework/LiveComponents/docs/COMPONENT-CREATION-GUIDE.md` (1114 lines)
|
|
- `./src/Framework/LiveComponents/docs/DEVTOOLS-DEBUGGING-GUIDE.md` (1163 lines)
|
|
- `./src/Framework/LiveComponents/docs/PERFORMANCE-GUIDE.md` (1023 lines)
|
|
- `./src/Framework/LiveComponents/docs/SECURITY-GUIDE.md` (1073 lines)
|
|
- `./src/Framework/LiveComponents/docs/UPLOAD-GUIDE.md` (953 lines)
|
|
- `./src/Framework/LiveComponents/ERROR-RECOVERY.md` (615 lines)
|
|
- `./src/Framework/LiveComponents/MEMORY-MANAGEMENT.md` (264 lines)
|
|
- `./src/Framework/LiveComponents/README.md` (75 lines)
|
|
- `./src/Framework/LiveComponents/TODO.md` (1216 lines)
|
|
- `./src/Framework/Mcp/README.md` (224 lines)
|
|
- `./src/Framework/Mcp/Tools/Categories/Analysis/README.md` (19 lines)
|
|
- `./src/Framework/Mcp/Tools/Categories/Database/README.md` (37 lines)
|
|
- `./src/Framework/Mcp/Tools/Categories/Development/README.md` (30 lines)
|
|
- `./src/Framework/Mcp/Tools/Categories/Performance/README.md` (36 lines)
|
|
- `./src/Framework/Mcp/Tools/Categories/README.md` (70 lines)
|
|
- `./src/Framework/Mcp/Tools/Categories/Security/README.md` (51 lines)
|
|
- `./src/Framework/Mcp/Tools/Categories/System/README.md` (51 lines)
|
|
- `./src/Framework/Notification/Channels/Telegram/Webhook/README.md` (198 lines)
|
|
- `./src/Framework/Notification/Media/README.md` (497 lines)
|
|
- `./src/Framework/Notification/README.md` (440 lines)
|
|
- `./src/Framework/Notification/Templates/README.md` (524 lines)
|
|
- `./src/Framework/OAuth/README.md` (539 lines)
|
|
- `./src/Framework/Performance/ARCHITECTURE.md` (234 lines)
|
|
- `./src/Framework/Performance/README.md` (369 lines)
|
|
- `./src/Framework/Quality/PHPStan/Rules/Naming/README.md` (238 lines)
|
|
- `./src/Framework/RateLimit/MIGRATION.md` (337 lines)
|
|
- `./src/Framework/ReflectionLegacy/EVALUATION.md` (191 lines)
|
|
- `./src/Framework/ReflectionLegacy/README.md` (166 lines)
|
|
- `./src/Framework/ReflectionLegacy/SUMMARY.md` (85 lines)
|
|
- `./src/Framework/Reflection/README.md` (203 lines)
|
|
- `./src/Framework/Retry/README.md` (287 lines)
|
|
- `./src/Framework/Serializer/README.md` (344 lines)
|
|
- `./src/Framework/Storage/STREAMING_IMPLEMENTATION_PLAN.md` (155 lines)
|
|
- `./src/Framework/Telemetry/README.md` (192 lines)
|
|
- `./src/Framework/View/Processors/docs/AssetInjector.md` (62 lines)
|
|
- `./src/Framework/View/Processors/docs/CommentStripProcessor.md` (54 lines)
|
|
- `./src/Framework/View/Processors/docs/ComponentProcessor.md` (55 lines)
|
|
- `./src/Framework/View/Processors/docs/DateFormatProcessor.md` (65 lines)
|
|
- `./src/Framework/View/Processors/docs/EscapeProcessor.md` (55 lines)
|
|
- `./src/Framework/View/Processors/docs/ForProcessor.md` (61 lines)
|
|
- `./src/Framework/View/Processors/docs/IfProcessor.md` (50 lines)
|
|
- `./src/Framework/View/Processors/docs/IncludeProcessor.md` (48 lines)
|
|
- `./src/Framework/View/Processors/docs/LayoutTagProcessor.md` (59 lines)
|
|
- `./src/Framework/View/Processors/docs/MetaManipulator.md` (53 lines)
|
|
- `./src/Framework/View/Processors/docs/PlaceholderReplacer.md` (36 lines)
|
|
- `./src/Framework/View/Processors/docs/README.md` (110 lines)
|
|
- `./src/Framework/View/Processors/docs/RemoveEmptyLinesProcessor.md` (65 lines)
|
|
- `./src/Framework/View/Processors/docs/SingleLineHtmlProcessor.md` (63 lines)
|
|
- `./src/Framework/View/Processors/docs/SlotProcessor.md` (58 lines)
|
|
- `./src/Framework/View/Processors/docs/SwitchCaseProcessor.md` (63 lines)
|
|
- `./src/Framework/View/Processors/docs/VoidElementsSelfClosingProcessor.md` (80 lines)
|
|
- `./src/Framework/WebPush/USAGE.md` (436 lines)
|
|
- `./src/Infrastructure/Api/Gitea/README.md` (501 lines)
|
|
- `./src/Infrastructure/Api/Netcup/README.md` (387 lines)
|
|
- `./src/Infrastructure/Api/RapidMail/README.md` (252 lines)
|
|
- `./src/Infrastructure/Api/README.md` (133 lines)
|
|
|
|
### 5. Deployment Documentation
|
|
|
|
- `./deployment/ansible/playbooks/README-WIREGUARD.md` (419 lines)
|
|
- `./deployment/ansible/README.md` (378 lines)
|
|
- `./deployment/docs/guides/code-change-workflow.md` (551 lines)
|
|
- `./deployment/docs/guides/deployment-commands.md` (172 lines)
|
|
- `./deployment/docs/guides/quick-start.md` (192 lines)
|
|
- `./deployment/docs/guides/setup-guide.md` (793 lines)
|
|
- `./deployment/docs/guides/vault-password.md` (262 lines)
|
|
- `./deployment/docs/history/cleanup-log.md` (125 lines)
|
|
- `./deployment/docs/history/cleanup-summary.md` (176 lines)
|
|
- `./deployment/docs/README.md` (204 lines)
|
|
- `./deployment/docs/reference/application-stack.md` (577 lines)
|
|
- `./deployment/docs/reference/workflow-troubleshooting.md` (186 lines)
|
|
- `./deployment/docs/RESTRUCTURE_PROPOSAL.md` (223 lines)
|
|
- `./deployment/docs/status/ci-cd-status.md` (272 lines)
|
|
- `./deployment/docs/status/deployment-summary.md` (188 lines)
|
|
- `./deployment/docs/status/deployment-todo.md` (291 lines)
|
|
- `./deployment/docs/status/improvements.md` (260 lines)
|
|
- `./deployment/docs/status/next-steps.md` (48 lines)
|
|
- `./deployment/docs/tests/git-deployment-issue.md` (73 lines)
|
|
- `./deployment/docs/tests/git-deployment-test.md` (239 lines)
|
|
- `./deployment/docs/tests/quick-test.md` (45 lines)
|
|
- `./deployment/docs/tests/recommended-test-flow.md` (144 lines)
|
|
- `./deployment/docs/tests/test-git-deployment.md` (277 lines)
|
|
- `./deployment/docs/tests/test-results.md` (72 lines)
|
|
- `./deployment/docs/troubleshooting/staging-502-nginx-phpfpm.md` (200 lines)
|
|
- `./deployment/gitea-runner/ADD_PHP_CI_LABEL.md` (110 lines)
|
|
- `./deployment/gitea-runner/README.md` (724 lines)
|
|
- `./deployment/README.md` (303 lines)
|
|
- `./deployment/stacks/application/README.md` (918 lines)
|
|
- `./deployment/stacks/gitea/README.md` (467 lines)
|
|
- `./deployment/stacks/minio/README.md` (657 lines)
|
|
- `./deployment/stacks/monitoring/README.md` (751 lines)
|
|
- `./deployment/stacks/postgresql/README.md` (681 lines)
|
|
- `./deployment/stacks/redis/README.md` (291 lines)
|
|
- `./deployment/stacks/registry/README.md` (636 lines)
|
|
- `./deployment/stacks/semaphore/QUICKSTART.md` (201 lines)
|
|
- `./deployment/stacks/semaphore/README.md` (576 lines)
|
|
- `./deployment/stacks/semaphore/SETUP_REPOSITORY.md` (355 lines)
|
|
- `./deployment/stacks/staging/README.md` (171 lines)
|
|
- `./deployment/stacks/traefik/README.md` (442 lines)
|
|
- `./deployment/wireguard/CLIENT-IMPORT-GUIDE.md` (370 lines)
|
|
- `./deployment/wireguard/configs/README.md` (47 lines)
|
|
- `./deployment/wireguard/INDEX.md` (259 lines)
|
|
- `./deployment/wireguard/INSTALLATION-LOG.md` (275 lines)
|
|
- `./deployment/wireguard/QUICKSTART.md` (194 lines)
|
|
- `./deployment/wireguard/README.md` (352 lines)
|
|
|
|
---
|
|
|
|
## Recommendations
|
|
|
|
### Phase 1: Immediate Actions (Week 1)
|
|
|
|
1. **Archive Outdated Files** (~30-40 files)
|
|
- Backups directory: `./backups/docs-backup-20250731125004/` (15 files)
|
|
- Old WireGuard docs: `./deployment/wireguard/` (5 files)
|
|
- Obsolete planning docs in `./docs/planning/`
|
|
|
|
2. **Create Master Index**
|
|
- New file: `/docs/README.md`
|
|
- Comprehensive navigation structure
|
|
- Links to all major documentation sections
|
|
|
|
3. **Consolidate LiveComponents**
|
|
- Current: 13 files in `/docs/livecomponents/`
|
|
- Target: Merge into 5-6 well-organized files
|
|
- Remove duplicates
|
|
|
|
### Phase 2: Reorganization (Week 2-3)
|
|
|
|
#### Proposed New Structure
|
|
|
|
```
|
|
/docs/
|
|
├── README.md # Master index & navigation
|
|
├── getting-started/
|
|
│ ├── installation.md
|
|
│ ├── quick-start.md
|
|
│ └── first-feature.md
|
|
├── architecture/
|
|
│ ├── overview.md
|
|
│ ├── design-patterns.md
|
|
│ ├── core-principles.md
|
|
│ └── directory-structure.md
|
|
├── features/
|
|
│ ├── database/
|
|
│ │ ├── README.md
|
|
│ │ ├── migrations.md
|
|
│ │ ├── entity-manager.md
|
|
│ │ └── repositories.md
|
|
│ ├── queue-system/
|
|
│ │ ├── README.md
|
|
│ │ ├── basics.md
|
|
│ │ ├── jobs.md
|
|
│ │ └── workers.md
|
|
│ ├── events/
|
|
│ ├── security/
|
|
│ ├── livecomponents/
|
|
│ └── ...
|
|
├── guides/
|
|
│ ├── building-features.md
|
|
│ ├── testing-strategies.md
|
|
│ ├── performance-optimization.md
|
|
│ └── deployment-guide.md
|
|
├── api-reference/
|
|
│ └── (auto-generated from source code)
|
|
├── contributing/
|
|
│ ├── code-style.md
|
|
│ ├── pull-requests.md
|
|
│ └── testing.md
|
|
└── deployment/
|
|
├── docker.md
|
|
├── production.md
|
|
└── monitoring.md
|
|
|
|
/docs/claude/ # AI-specific only
|
|
├── CLAUDE.md # Main AI context
|
|
├── mcp-integration.md # MCP server usage
|
|
├── framework-personas.md # AI personas
|
|
└── examples/ # Code generation examples
|
|
```
|
|
|
|
### Phase 3: Content Migration
|
|
|
|
**Files to Move from /docs/claude/ to /docs/:**
|
|
- architecture.md → /docs/architecture/overview.md
|
|
- database-patterns.md → /docs/features/database/
|
|
- queue-system.md → /docs/features/queue-system/
|
|
- event-system.md → /docs/features/events/
|
|
- security-patterns.md → /docs/features/security/
|
|
- error-handling.md → /docs/features/error-handling/
|
|
- common-workflows.md → /docs/guides/building-features.md
|
|
- troubleshooting.md → /docs/guides/troubleshooting.md
|
|
|
|
**Files to Keep in /docs/claude/:**
|
|
- CLAUDE.md (AI context)
|
|
- mcp-integration.md (MCP server specific)
|
|
- framework-personas.md (AI personas)
|
|
- development-commands.md (Claude Code commands)
|
|
|
|
### Phase 4: Maintenance & Quality
|
|
|
|
1. **Standardize Format**
|
|
- Apply documentation template to all files
|
|
- Consistent heading structure
|
|
- Code example formatting
|
|
- Cross-reference links
|
|
|
|
2. **Add Navigation**
|
|
- Breadcrumb navigation in each file
|
|
- "See Also" sections
|
|
- Previous/Next links where applicable
|
|
|
|
3. **Update Cross-References**
|
|
- Fix all internal links after migration
|
|
- Update CLAUDE.md references
|
|
- Verify no broken links
|
|
|
|
4. **Documentation Governance**
|
|
- Create CONTRIBUTING_DOCS.md
|
|
- Define archival policy
|
|
- Establish review process
|
|
|
|
---
|
|
|
|
## File Statistics Summary
|
|
|
|
### By Size Category
|
|
- **Large (1000+ lines):** ~15 files
|
|
- database-patterns.md (38K lines)
|
|
- typed-string-system.md (30K lines)
|
|
- posix-system.md (25K lines)
|
|
|
|
- **Medium (500-1000 lines):** ~25 files
|
|
- event-system.md, queue-system.md, guidelines.md
|
|
|
|
- **Small (100-500 lines):** ~60 files
|
|
- Most feature documentation
|
|
|
|
- **Stubs (<100 lines):** ~15 files
|
|
- async-components.md (520 bytes)
|
|
- console-commands.md (612 bytes)
|
|
- performance-monitoring.md (594 bytes)
|
|
|
|
### Duplicates Identified
|
|
1. **livecomponent-lazy-loading.md** vs **livecomponents-lazy-loading.md** (681 vs 717 lines)
|
|
2. Multiple backup copies in `/backups/docs-backup-20250731125004/`
|
|
|
|
### Obsolete Files (Candidates for Archival)
|
|
1. All files in `/backups/` directory (15 files)
|
|
2. Old WireGuard documentation (5 files) - VPN removed from architecture
|
|
3. Outdated planning documents (11 files in `/docs/planning/`)
|
|
4. Old component docs (migration completed)
|
|
|
|
**Total to Archive:** ~40-50 files
|
|
**Reduction:** From 513 to ~470 active files (-8.4%)
|
|
|
|
---
|
|
|
|
## Next Steps
|
|
|
|
### Immediate (This Week)
|
|
1. Review this analysis
|
|
2. Approve proposed structure
|
|
3. Create `/docs/README.md` master index
|
|
4. Archive obsolete files
|
|
|
|
### Short-term (Next 2 Weeks)
|
|
1. Create new directory structure
|
|
2. Begin file migration (prioritize high-traffic docs)
|
|
3. Update cross-references
|
|
4. Standardize formatting
|
|
|
|
### Ongoing
|
|
1. Complete all migrations
|
|
2. Add missing documentation for 46 undocumented modules
|
|
3. Establish documentation maintenance process
|
|
4. Regular quarterly reviews
|
|
|
|
---
|
|
|
|
## Contact & Support
|
|
|
|
For questions about this analysis or documentation reorganization:
|
|
- Review full analysis at: `/tmp/markdown-analysis.md`
|
|
- Documentation issues: Use GitHub Issues
|
|
- Framework questions: See /docs/claude/CLAUDE.md
|
|
|
|
**Generated:** 2025-01-28
|
|
**Total Analysis Time:** ~5 minutes
|
|
**Files Analyzed:** 513 markdown files
|