Documentation
Technical documentation from the engine repository: core set 01–08 (architecture through operations), the index, and supplementary policy and ops documents. Click a document to see the full content, including Mermaid diagrams.
Public documentation boundary
This documentation explains functional behavior, architecture, and observability in depth, while intentionally omitting source code, private account details, and strategically reproducible tuning values.
| Topic | Document |
|---|---|
| Module inventory (00) All src modules with role and runtime gates. | 00_MODULE_INVENTORY.md |
| Architecture (01) System overview: data flow, DB topology, processes. | 01_ARCHITECTURE.md |
| Data & ingest (02) Market feeds, persistent ingest, metrics. | 02_DATA_INGEST.md |
| Strategy pipeline (03) Signals, route engine, edge and confidence. | 03_STRATEGY_PIPELINE.md |
| Execution & orders (04) Order lifecycle, fills, dead man's switch. | 04_EXECUTION_ORDERS.md |
| Protection & exit (05) Positions, stops/trails, exit scenarios. | 05_PROTECTION_EXIT.md |
| Risk & safety (06) Capital allocator, safety state, circuit breakers. | 06_RISK_SAFETY.md |
| Observability (07) Logging, metrics, forward returns, snapshots. | 07_OBSERVABILITY.md |
| Operations (08) Deploy, systemd, validation scripts, incidents. | 08_OPERATIONS.md |
| Strategy Families (09) The six strategy families: breakout, momentum, mean reversion, maker, volatility, liquidity. | 09_STRATEGIES.md |
| Investor Overview (12) Technically honest overview of architecture, risk management, and operational state. | 12_INVESTOR_OVERVIEW.md |
| Investor Risk Report (13) Honest inventory of risks and limitations in the current state of the system. | 13_INVESTOR_RISK_REPORT.md |
| DECIMAL_F64_POLICY_AND_INVENTORY | DECIMAL_F64_POLICY_AND_INVENTORY.md |
| DOCS_TARGET_STRUCTURE | DOCS_TARGET_STRUCTURE.md |
| Document index Central map: core 01–08, module inventory, and specialized documents. | DOC_INDEX.md |
| FASE_0B_RUNTIME | FASE_0B_RUNTIME.md |
| FORWARD_RETURNS_OBSERVABILITY | FORWARD_RETURNS_OBSERVABILITY.md |
| SYSTEMD_README | SYSTEMD_README.md |
| TERMINOLOGY_DATABASE | TERMINOLOGY_DATABASE.md |
| WEBSITE_SOURCE_OF_TRUTH | WEBSITE_SOURCE_OF_TRUTH.md |