Stack-2-9-finetuned / docs /DIRECTORY_STRUCTURE.md
walidsobhie-code
reorganize: consolidate root level to 20 folders
b8e3e42
# Stack 2.9 Directory Structure
## Quick Overview
```
stack-2.9/
β”œβ”€β”€ src/ # Core source code (voice, LLM, MCP, indexing)
β”œβ”€β”€ stack/ # Components (deploy, training, eval, voice, docs)
β”œβ”€β”€ data/ # Training datasets
β”œβ”€β”€ scripts/ # Utility scripts
β”œβ”€β”€ samples/ # Examples & tests
β”œβ”€β”€ docs/ # Documentation
β”‚
β”œβ”€β”€ README.md # Main docs
β”œβ”€β”€ LICENSE # Apache 2.0
β”œβ”€β”€ package.json # npm config
β”œβ”€β”€ pyproject.toml # Python config
└── .env.example # Environment template
```
## Structure Details
### Root Files (User-Facing)
| File | Purpose |
|------|---------|
| README.md | Main documentation |
| LICENSE | Apache 2.0 license |
| CHANGELOG.md | Version history |
| CONTRIBUTING.md | Contribution guide |
| SECURITY.md | Security policy |
| .env.example | Environment variables |
| package.json | npm dependencies |
| pyproject.toml | Python project |
| requirements.txt | Python deps |
| Dockerfile | Container config |
| Makefile | Build targets |
| colab_train_stack29.ipynb | Colab training |
### Core Modules (`src/`)
- **src/voice/** - Voice integration (recording, synthesis, cloning)
- **src/llm/** - Multi-provider LLM client
- **src/mcp/** - Model Context Protocol client
- **src/indexing/** - Code indexing (RAG)
- **src/cli/** - CLI tools
- **src/utils/** - Utilities
### Components (`stack/`)
- **stack/deploy/** - Docker & deployment configs
- **stack/training/** - Model fine-tuning code
- **stack/eval/** - Evaluation & benchmarks
- **stack/voice/** - Python voice API server
- **stack/docs/** - API documentation
- **stack/internal/** - Internal docs (archive)
### Data & Scripts
- **data/** - Training datasets
- **scripts/** - Build & utility scripts
- **samples/** - Examples & test files