Skip to content

Latest commit

 

History

History
148 lines (105 loc) · 4.92 KB

README.md

File metadata and controls

148 lines (105 loc) · 4.92 KB

Project Documentation

Welcome to the AI Customer Support Agent documentation. This directory contains comprehensive technical documentation for the entire system.

📐 Architecture

Core Documentation

Specialized Architecture

📚 Guides

Step-by-step setup and configuration guides:

🚶 Walkthroughs

For Developers

  • Code Walkthrough - Critical flows: auth, routing, data fetching, and knowledge base management

For Users

💬 AI Prompts

System prompts and templates used by the AI agent:

  • Prompts Directory - All prompt templates
    • Agent system prompts
    • Email classification prompts
    • Response generation templates
    • Retriever tool descriptions

📄 Product Documentation

🗺️ Documentation Map

graph TB
    Start[Start Here]
    
    Start --> PRD[Product Requirements<br/>PRD.md]
    Start --> Arch[System Architecture<br/>architecture/README.md]
    Start --> Code[Code Walkthrough<br/>walkthroughs/code_walkthrough.md]
    
    Arch --> HLD[High-Level Design<br/>architecture/HIGH_LEVEL_DESIGN.md]
    Arch --> Seq[Sequence Diagrams<br/>architecture/SEQUENCE_DIAGRAMS.md]
    Arch --> LLM[Multi-LLM Architecture<br/>architecture/llm/README.md]
    Arch --> VDB[Multi-Vector DB Architecture<br/>architecture/vector_db/README.md]
    
    Code --> Setup[Main Walkthrough<br/>walkthroughs/main_walkthrough.md]
    
    Setup --> Guides[Setup Guides<br/>guides/]
    Guides --> Gmail[Gmail Setup<br/>guides/gmail_setup_guide.md]
Loading

🎯 Quick Navigation

I want to...

Understand the system architecture → Start with Architecture Overview
→ Then read High-Level Design

Understand the code → Read Code Walkthrough

Set up the system → Follow Main Walkthrough
→ Reference Gmail Setup Guide as needed

Understand multi-LLM support → Read Multi-LLM Architecture
→ Check Sequence Diagrams - LLM Fallback

Understand multi-Vector DB support → Read Multi-Vector DB Architecture
→ Check Sequence Diagrams - Vector Search

See how emails are processed → Check Sequence Diagrams - Email Processing

📖 Documentation Standards

Diagrams

All architecture diagrams use Mermaid syntax for:

  • Component diagrams
  • Sequence diagrams
  • State diagrams
  • Flow charts

Code Examples

  • Python code blocks use syntax highlighting
  • Examples are complete and runnable
  • Configuration snippets show actual .env format

File References

  • All file paths use absolute paths
  • Code references link to actual files
  • Line numbers included where relevant

🔄 Documentation Maintenance

This documentation was generated from the codebase on 2025-11-29 and should be updated when:

  • New providers are added
  • Architecture changes significantly
  • New features are implemented
  • Breaking changes occur

📊 Documentation Coverage

Architecture ✅

  • System overview
  • High-level design
  • Sequence diagrams (9 workflows)
  • Multi-LLM architecture
  • Multi-Vector DB architecture

Code ✅

  • Complete code walkthrough
  • Design patterns explanation
  • Service layer documentation

Guides ✅

  • Gmail setup
  • LLM configuration
  • Vector DB configuration
  • Main user walkthrough

Product ✅

  • PRD (Product Requirements)
  • User stories
  • Technical specifications

Last Updated: November 30, 2025
Codebase Version: Python 3.12+
Architecture Status: Multi-LLM ✅ | Multi-Vector DB ✅ | Gmail Integration ✅ | Separated Auth/Dashboard ✅