logan/drb-overview
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add readme

Browse Source
This commit is contained in:
Logan Cusano
2025-12-28 14:09:00 -05:00
parent e08464abda
commit 707918a52f
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md Normal file
View File

@@ -0,0 +1,17 @@
# Project Codex Documentation
This directory contains the high-level documentation, architectural designs, and roadmap for **Project Codex** (Discord Radio Bot).
## Documentation Index
### 1. [Project Overview](./overview.md)
**Start here.** This document provides the executive summary, core workflow, and a high-level explanation of the system components. It explains *what* the system is and *why* it exists.
### 2. [Architecture & Data Flow](./arch.md)
This document dives into the technical details. It covers:
- The 5 core components (C2, Edge Node, Intelligence Engine, Web Portal).
- Data models for Firestore (Nodes, Incidents).
- The flow of data from RF to the User Interface.
### 3. [Development Roadmap](./roadmap.md)
The master plan for development. It breaks the project down into 5 distinct phases, from core stability to advanced AI intelligence, with specific task checklists.