1---2name: atomic-framework-doc-map3description: Use when you need a fast cross-reference of all 44 Atomic Framework documentation files to find which doc covers which subsystem, feature, or integration.4---5
6# Atomic Framework Documentation Map
7
8## When to Use
9- Looking for the right doc file before editing a subsystem.
10- Finding all docs related to a feature family.
11- Cross-referencing a doc to the engine path that implements it.
12
13## Cross-Reference Table
14
15| Category | Doc file | Engine path | Skill |
16|---|---|---|---|
17| Architecture | `docs/README.md` | all | `atomic-framework-overview` |
18| Bootstrap | `docs/applications.md` | `Core/App.php`, `App/*` | `atomic-framework-core` |
19| Config | `docs/config.md` | `Core/Config/*` | `atomic-framework-core` |
20| Prefly | `docs/prefly.md` | `Core/Prefly.php` | `atomic-framework-core` |
21| Request | `docs/request.md` | `Core/Request.php`, `Core/Methods.php` | `atomic-framework-core` |
22| Middleware | `docs/middleware.md` | `Core/Middleware/*` | `atomic-framework-core` |
23| Logging | `docs/log.md` | `Core/Log.php`, `Core/LogChannel.php` | `atomic-framework-core` |
24| Error handling | `docs/errorhandler.md` | `Core/ErrorHandler.php` | `atomic-framework-core` |
25| Security | `docs/security.md` | `Core/Crypto.php`, `Core/Guard.php` | `atomic-framework-core` |
26| Database | `docs/database.md` | `Core/ConnectionManager.php` | `atomic-framework-core` |
27| Migrations | `docs/migrations.md` | `Core/Migrations.php`, `CLI/Migrations.php` | `atomic-framework-core`, `atomic-framework-cli-api` |
28| Model | `docs/model.md` | `App/Model.php`, `Validator/*` | `atomic-framework-data` |
29| Atomic Core ref | `docs/atomic_core.md` | `Core/` (all) | `atomic-framework-core` |
30| Atomic Methods | `docs/atomic_methods.md` | `Core/Methods.php`, `Support/helpers.php` | `atomic-framework-core` |
31| PDF export | `docs/atomic_pdf.md` | `Files/PDF.php` | `atomic-framework-data` |
32| XLS export | `docs/atomic_xls.md` | `Files/XLS.php` | `atomic-framework-data` |
33| CLI | `docs/cli.md` | `CLI/*` | `atomic-framework-cli-api` |
34| Events | `docs/event.md` | `Event/Event.php` | `atomic-framework-event-hook-lang-mail` |
35| Hooks | `docs/hook.md` | `Hook/Hook.php` | `atomic-framework-event-hook-lang-mail` |
36| i18n | `docs/i18n.md` | `Lang/I18n.php` | `atomic-framework-event-hook-lang-mail` |
37| Mailer | `docs/mailer.md` | `Mail/Mailer.php` | `atomic-framework-event-hook-lang-mail` |
38| Notifier | `docs/notifier.md` | `Mail/Notifier.php` | `atomic-framework-event-hook-lang-mail` |
39| Template | `docs/template.md` | F3 Template engine | `atomic-framework-theme` |
40| Theme | `docs/theme.md` | `Theme/Theme.php` | `atomic-framework-theme` |
41| Head | `docs/head.md` | `Theme/Head.php` | `atomic-framework-theme` |
42| Assets | `docs/assets.md` | `Theme/Assets.php` | `atomic-framework-theme` |
43| OpenGraph | `docs/opengraph.md` | `Theme/OpenGraph.php`, `Theme/Schema.php` | `atomic-framework-theme` |
44| Redactor | `docs/redactor.md` | `Core/Redactor.php`, `Theme/Redactor.php` | `atomic-framework-core`, `atomic-framework-theme` |
45| Session | `docs/session.md` | `Auth/Session.php`, `Session/SessionManager.php` | `atomic-framework-mutex-session` |
46| Mutex | `docs/mutex.md` | `Mutex/Mutex.php` | `atomic-framework-mutex-session` |
47| Nonce | `docs/nonce.md` | `Tools/Nonce.php` | `atomic-framework-mutex-session` |
48| Transient | `docs/transient.md` | `Tools/Transient.php`, `Cache/*` | `atomic-framework-mutex-session` |
49| Queue | `docs/queue.md` | `Queue/Managers/Manager.php` | `atomic-framework-queue-scheduler-telemetry` |
50| Scheduler | `docs/scheduler.md` | `Scheduler/Scheduler.php` | `atomic-framework-queue-scheduler-telemetry` |
51| Telemetry | `docs/telemetry.md` | `Telemetry/*` | `atomic-framework-queue-scheduler-telemetry` |
52| Plugins | `docs/plugins.md` | `App/Plugin.php`, `App/PluginManager.php` | `atomic-framework-plugins` |
53| Monopay | `docs/plugins/monopay.md` | `Plugins/Monopay/*` | `atomic-framework-plugins` |
54| WordPress | `docs/plugins/wordpress.md` | `Plugins/WordPress/*` | `atomic-framework-plugins` |
55| WooCommerce | `docs/plugins/woocommerce.md` | `Plugins/WooCommerce/*` | `atomic-framework-plugins` |
56| RSS Reader | `docs/plugins/rss-reader.md` | `Plugins/RssReader/*` | `atomic-framework-plugins` |
57| AI Connector | `docs/ai_connector.md` | `Tools/AIConnector.php` | `atomic-framework-tools-websockets` |
58| WebSockets | `docs/websockets.md` | `WebSockets/Server.php` | `atomic-framework-tools-websockets` |
59| Telegram | `docs/telegram.md` | `Tools/Telegram.php`, `Auth/TelegramAuth.php` | `atomic-framework-tools-websockets`, `atomic-framework-app-auth` |
60| Testing | `docs/testing_guide.md` | `tests/` | all |
61
62## Skills Index
63
64| Skill | Focus |
65|---|---|
66| `atomic-framework-overview` | Architecture, modules, bootstrap, routing map |
67| `atomic-framework-core` | Bootstrap, config, middleware, logging, routing, crypto, migrations |
68| `atomic-framework-data` | Models, validation, enums, exceptions, file export, helpers |
69| `atomic-framework-app-auth` | Controllers, app models, auth, session, OAuth |
70| `atomic-framework-cli-api` | CLI commands, API, scaffolding, console output |
71| `atomic-framework-event-hook-lang-mail` | Events, hooks, filters, i18n, mail, notifier |
72| `atomic-framework-mutex-session` | Mutex, session, nonce, transient |
73| `atomic-framework-queue-scheduler-telemetry` | Queue, scheduler, telemetry panel |
74| `atomic-framework-theme` | Theme, head, assets, OpenGraph, schema |
75| `atomic-framework-plugins` | Plugin lifecycle, PluginManager, built-in integrations |
76| `atomic-framework-tools-websockets` | AI Connector, WebSocket server, Telegram |
77| `atomic-framework-doc-map` | This index |
78
79## Guardrails
80- If a doc file exists for a subsystem, read it before making assumptions about behavior.
81- Docs in `docs/plugins/` cover integration-specific APIs; treat them as supplementary.
82- `docs/testing_guide.md` applies to all subsystems when writing tests.
MADEVAL