From 707918a52fb93dd06baba1827c9a2e902f7b336d Mon Sep 17 00:00:00 2001 From: Logan Cusano Date: Sun, 28 Dec 2025 14:09:00 -0500 Subject: [PATCH] add readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9f7f56d --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file