meetara / docs /README.md
rameshbasina's picture
Remove QUICK_START.md and reorganize documentation structure; add detailed deployment guide for Hugging Face Spaces and performance optimization documentation for agent mode.
7002c4d
# MeeTARA Documentation
Welcome to the MeeTARA documentation! This folder contains all technical documentation organized by category.
## πŸ“ Documentation Structure
```
docs/
β”œβ”€β”€ README.md # This file
β”œβ”€β”€ architecture/
β”‚ └── core-vs-agent.md # Core vs Agent architecture analysis
β”œβ”€β”€ deployment/
β”‚ └── huggingface-spaces.md # HuggingFace Spaces deployment guide
β”œβ”€β”€ features/
β”‚ β”œβ”€β”€ domain-prompts.md # Domain-specific system prompts
β”‚ └── word-problems.md # Word problem handling strategy
└── testing/
└── test-questions.md # Comprehensive test questions
```
## πŸ“š Documentation Index
### Architecture
- **[Core vs Agent Analysis](architecture/core-vs-agent.md)** - Detailed comparison of MeeTARA's two-layer architecture:
- `meetara_lab_core.py` - Model interface layer (the "engine")
- `meetara_agent.py` - Tool orchestration layer (the "orchestrator")
### Deployment
- **[HuggingFace Spaces](deployment/huggingface-spaces.md)** - Complete guide for deploying MeeTARA to HuggingFace Spaces:
- Quick start options
- Resource considerations
- Troubleshooting
### Features
- **[Domain-Specific Prompts](features/domain-prompts.md)** - How MeeTARA handles domain-specific system prompts:
- Current architecture
- Domain mapping structure
- Implementation recommendations
- **[Word Problem Strategy](features/word-problems.md)** - How MeeTARA handles different types of word problems:
- Simple math β†’ Calculator
- Complex word problems β†’ Model directly
- Current events β†’ Web search + Model
### Testing
- **[Test Questions](testing/test-questions.md)** - Comprehensive test questions covering:
- Math & Calculator queries
- Scientific functions & algorithms
- Web search & current events
- Combined queries
- Edge cases
## πŸ”— Quick Links
- [Main README](../README.md) - Project overview and features
- [Configuration](../config/) - Configuration files
- [Core Module](../core/) - Core model and agent code
---
*Last updated: January 2026*