# 📚 Mem-Agent Documentation Index

This folder serves as the documentation center for Mem-Agent.

## 📖 Main Documentation

### Root Folder Files

Main documentation files are located in the project root folder:

1. **[README.md](../README.md)** - Main README file
   - Project overview
   - Features
   - Installation instructions
   - Basic usage

2. **[QUICKSTART.md](../QUICKSTART.md)** - Quick Start Guide
   - Get started in 5 minutes
   - Step-by-step installation
   - First examples

3. **[INTEGRATION_GUIDE.md](../INTEGRATION_GUIDE.md)** - Integration Guide
   - Web API integration
   - Database connections
   - Production deployment
   - Custom configurations

4. **[docs/CONFIG_GUIDE.md](CONFIG_GUIDE.md)** - Configuration Guide ⭐ NEW
   - How to create config file
   - All settings explained in detail
   - Examples by use case
   - Troubleshooting

5. **[CHANGELOG.md](../CHANGELOG.md)** - Changelog
   - Version history
   - New features
   - Bug fixes

6. **[LICENSE](../LICENSE)** - License File
   - MIT License

## 🎯 Usage Examples

Example codes are located in `../examples/` folder:

- **example_simple.py** - Simple getting started example
- **example_business_mode.py** - Business usage
- **example_personal_mode.py** - Personal assistant
- **example_customer_service.py** - Customer service
- **example_memory_tools.py** - Memory tools
- **demo_user_tools.py** - User tools demo

## 🧪 Test Files

Test files are in `../tests/` folder:

- **test_mem_agent.py** - MemAgent tests
- **test_integration.py** - Integration tests
- **test_memory_manager.py** - Memory manager tests
- **test_memory_tools.py** - Tools tests
- **test_llm_client.py** - LLM client tests

## 📦 Configuration

- **[config.yaml](../config.yaml)** - Current configuration file
- **[config.yaml.example](../config.yaml.example)** - Example config template ⭐ NEW
- **[docs/CONFIG_GUIDE.md](CONFIG_GUIDE.md)** - Detailed config guide ⭐ NEW
- **[requirements.txt](../requirements.txt)** - Python dependencies
- **[setup.py](../setup.py)** - Installation script

## 🔧 Core Modules

Main modules are in the root folder:

- `mem_agent.py` - Main agent class
- `memory_manager.py` - JSON memory manager
- `memory_db.py` - SQL memory manager
- `memory_tools.py` - User tools
- `llm_client.py` - LLM connection
- `prompt_templates.py` - Prompt templates
- `config_manager.py` - Configuration manager
- `knowledge_loader.py` - Knowledge base loader

## 🌟 Recommended Reading Order for Beginners

1. **[QUICKSTART.md](../QUICKSTART.md)** - First 5 minutes
2. **[config.yaml.example](../config.yaml.example)** - Prepare config file ⭐
3. **[examples/example_simple.py](../examples/example_simple.py)** - First code example
4. **[docs/CONFIG_GUIDE.md](CONFIG_GUIDE.md)** - Detailed configuration
5. **[README.md](../README.md)** - All features
6. **[INTEGRATION_GUIDE.md](../INTEGRATION_GUIDE.md)** - Integrate into your project

## 💡 Help and Support

For your questions:
- GitHub Issues: Bug reports and feature requests
- Documentation: Files above
- Examples: `examples/` folder

---

Last updated: 2025-01-13
Version: 2.0.0