CODI Documentation Index
Welcome to the CODI documentation suite. Use this index to navigate the collection based on your role or task.
1. Getting Started
2. Architecture & Stack
| Topic |
Description |
| ARCHITECTURE.md |
System diagram, module deep dive, deployment models. |
| TECH_STACK.md |
Languages, dependencies, containers, CI/CD tooling. |
3. Usage Guides
4. Advanced Components
| Topic |
Description |
| LLM_MODULE.md |
Data pipeline, training, runtime integration, evaluation. |
| RULES_GUIDE.md |
Rules catalog structure, template authoring, CMD rewrites. |
| REPORTING.md |
Report artefacts, dashboard workflows. |
5. Operations & Security
| Topic |
Description |
| OPERATIONS.md |
Day-2 procedures, health checks, troubleshooting. |
| SECURITY.md |
Air-gap controls, container hardening, compliance artefacts. |
| CICD_RELEASE.md |
Release steps, signing, SBOMs, rollback plans. |
6. Quality & Contribution
| Topic |
Description |
| PERFORMANCE.md |
Performance budgets, codi perf, optimisation tips. |
| TESTING.md |
pytest suites, fixtures, coverage expectations. |
| CONTRIBUTING.md |
Development workflow, coding standards, review checklist. |
7. Reference Materials
| Topic |
Description |
| REFERENCE.md |
Command/API reference, file formats, glossary, roadmap. |
8. Role-Based Paths
| Role |
Suggested Path |
| Platform Engineer |
INTRODUCTION → ARCHITECTURE → CLI_GUIDE → SLIM_CONTAINER → CICD_RELEASE. |
| DevOps/SRE |
INSTALLATION → OPERATIONS → SECURITY → PERFORMANCE → REPORTING. |
| ML Engineer |
LLM_MODULE → DATA pipeline sections → COMPLETE_CONTAINER → REFERENCE. |
| Product/Leadership |
INTRODUCTION → REPORTING → DASHBOARD sections → REFERENCE summaries. |