63 lines
2.1 KiB
Markdown
63 lines
2.1 KiB
Markdown
|
# Documentation Directory
|
||
|
|
|
||
|
|
This directory contains all project documentation organized by category.
|
||
|
|
|
||
|
|
## Directory Structure
|
||
|
|
|
||
|
|
```
|
||
|
|
docs/
|
||
|
|
├── architecture/ - System design and architecture documentation
|
||
|
|
├── guides/ - User guides and getting started documentation
|
||
|
|
└── development/ - Implementation and development documentation
|
||
|
|
```
|
||
|
|
|
||
|
|
## Architecture Documentation (`./architecture/`)
|
||
|
|
|
||
|
|
Core system design and architecture:
|
||
|
|
|
||
|
|
- **ARCHITECTURE_GUIDE.md** - Comprehensive system architecture overview
|
||
|
|
- **INDEX.md** - Documentation index and navigation
|
||
|
|
- **DELIVERABLES.txt** - Project deliverables and specifications
|
||
|
|
|
||
|
|
## User Guides (`./guides/`)
|
||
|
|
|
||
|
|
Getting started and user-facing documentation:
|
||
|
|
|
||
|
|
- **QUICK_START.md** - Quick start guide for new users
|
||
|
|
- **START_HERE.md** - Initial project overview
|
||
|
|
- **USER_GUIDE.md** - Comprehensive user guide
|
||
|
|
- **INITIALIZATION_GUIDE.md** - System initialization instructions
|
||
|
|
- **PRESENTATION_README.md** - Presentation and demo guide
|
||
|
|
|
||
|
|
## Development Documentation (`./development/`)
|
||
|
|
|
||
|
|
Implementation and development resources:
|
||
|
|
|
||
|
|
- **IMPLEMENTATION_COMPLETE.md** - Implementation completion summary
|
||
|
|
- **IMPLEMENTATION_SUMMARY.md** - Implementation overview
|
||
|
|
- **E2E_TESTING_GUIDE.md** - End-to-end testing documentation
|
||
|
|
- **DOCKER_SETUP.md** - Docker configuration and setup
|
||
|
|
- **DOCUMENTATION_INDEX.md** - Development documentation index
|
||
|
|
|
||
|
|
## Root Level Files
|
||
|
|
|
||
|
|
Key files kept in project root for quick access:
|
||
|
|
|
||
|
|
- **README.md** - Main project README
|
||
|
|
- **CLAUDE.md** - Claude Code configuration
|
||
|
|
- **START_HERE_AFTER_REBOOT.md** - Post-reboot instructions
|
||
|
|
- **fixes-prompt.md** - Current work: API test fixes
|
||
|
|
- **frontend-plan.md** - Current work: Frontend planning
|
||
|
|
|
||
|
|
## Navigation
|
||
|
|
|
||
|
|
- For **architecture overview**: Start with `./architecture/ARCHITECTURE_GUIDE.md`
|
||
|
|
- For **getting started**: Start with `./guides/QUICK_START.md`
|
||
|
|
- For **development setup**: Start with `./development/DOCKER_SETUP.md`
|
||
|
|
- For **after system reboot**: See root `START_HERE_AFTER_REBOOT.md`
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Organized:** 2026-02-06
|
||
|
|
**Purpose:** Declutter root directory and improve documentation discoverability
|