# ๐ Documentation
Complete documentation for MCP Email Service.
---
## ๐ Quick Start Guides
These guides will help you get started quickly:
- **[HTTP API Quick Start](guides/HTTP_API_QUICK_START.md)** - Set up the HTTP API in minutes
- **[Email Translation Workflow](guides/EMAIL_TRANSLATE_WORKFLOW_GUIDE.md)** - Automatically translate and summarize emails
- **[n8n Email Monitoring](guides/N8N_EMAIL_MONITORING_GUIDE.md)** - Set up automated email monitoring with AI
- **[Lark/Feishu Setup](guides/LARK_SETUP_GUIDE.md)** - Configure Lark/Feishu webhooks
---
## ๐ User Guides
### Deployment & Production
- **[Production Deployment Guide](guides/PRODUCTION_DEPLOYMENT_GUIDE.md)** - Best practices for production deployment
- **[Security Setup Guide](guides/SECURITY_SETUP_GUIDE.md)** - Security configuration and best practices
- **[Final Deployment Checklist](guides/FINAL_DEPLOYMENT_CHECKLIST.md)** - Pre-deployment checklist
### Workflows & Integration
- **[n8n API Setup](guides/N8N_API_SETUP_GUIDE.md)** - Configure n8n API integration
- **[Translation Workflow Summary](guides/TRANSLATION_WORKFLOW_SUMMARY.md)** - Email translation workflow overview
- **[Open Source Readiness](guides/OPEN_SOURCE_READINESS.md)** - Preparing for open source release
---
## ๐๏ธ Technical Documentation
### Architecture & Design
- **[System Architecture](ARCHITECTURE.md)** - Complete system architecture overview
- **[Database Design](database_design.md)** - Database schema and design decisions
---
## ๐ Additional Resources
### Historical Documents
The `archive/` directory contains historical documents from development, including:
- Bug fix records
- Refactoring summaries
- Optimization logs
- Code review notes
These are kept for reference but are not required reading.
---
## ๐ค Contributing
For developers who want to contribute:
1. Read the [System Architecture](ARCHITECTURE.md) to understand the codebase
2. Check the [Database Design](database_design.md) for data models
3. Review the [Production Deployment Guide](guides/PRODUCTION_DEPLOYMENT_GUIDE.md) for deployment details
4. See historical documents in `archive/` if you need development context
---
## ๐ Support
- ๐ **Report bugs**: [GitHub Issues](https://github.com/leeguooooo/email-mcp-service/issues)
- ๐ฌ **Discussions**: [GitHub Discussions](https://github.com/leeguooooo/email-mcp-service/discussions)
- ๐ง **Contact**: See [main README](../README.md) for contact information
---
**Last Updated**: 2025-10-17