📂 English Documentation Hub
Welcome to the conceptual documentation for codex-bot. This section explains the "Why" and "How" behind the framework's architecture.
🗺️ Architecture Map
| Section | Description |
|---|---|
| 📦 Base | Core DTOs and the abstract Orchestrator. |
| 🧭 Director | Cross-feature transition coordinator. |
| ⚙️ Engine | Router assembly, discovery, and bot factory. |
| 🧠 FSM | State management and Garbage Collector. |
| 🔄 Redis | Redis Stream integration and background processing. |
| 📤 Sender | UI message delivery and synchronization. |
| 🛠️ CLI | Scaffolding commands for feature creation. |
| ✨ Animation | Waiting animations for Telegram UI. |
| 🔗 URL Signer | HMAC-signed URLs for Mini Apps. |
| 🧰 Helper | Context extraction and utility helpers. |
📜 Core Philosophy
codex-bot is built on three main pillars:
- Feature-based Isolation: Every feature is a self-contained module with its own logic, UI, and resources.
- Stateless Orchestrators: Orchestrators do not store user state in
self. All context is passed through theDirector. - UI Persistence: The framework manages two persistent messages (Menu and Content) to minimize chat clutter.
Last Updated: 2025-02-07