Skip to content

DOCUMENTATION_INDEX.md

Latest commit

 

History

History
313 lines (237 loc) · 13.8 KB

DOCUMENTATION_INDEX.md

File metadata and controls

313 lines (237 loc) · 13.8 KB

📚 Email Agent AI - Index Documentation

Guide de navigation pour toute la documentation du projet.

📂 Structure de la documentation

docs/
├── guides/           → Guides d'utilisation pour les utilisateurs
└── tech_doc/         → Documentation technique pour les développeurs
    ├── notes/        → Notes de développement et résumés de sessions
    └── *.md          → Documentation technique principale

🚀 Démarrage Rapide

Document Description Quand l'utiliser
docs/guides/QUICK_START.md Démarrage en 5 minutes Première installation locale
docs/guides/GMAIL_EXAMPLE.md Tutorial Gmail pas-à-pas Premier ajout de compte Gmail
docs/guides/ORACLE_CLOUD_QUICKSTART.md Guide Oracle Cloud Déploiement sur Oracle Cloud

📖 Guides d'Utilisation

Localisation : docs/guides/

Démarrage & Installation

Document Description Niveau
QUICK_START.md Guide de démarrage général 🟢 Débutant
QUICK_START_PHASE2.md Démarrage avec actions Phase 2 🟢 Débutant
ORACLE_CLOUD_QUICKSTART.md Démarrage Oracle Cloud 🟡 Intermédiaire

Configuration des Comptes Email

Document Description Niveau
ADD_EMAIL_ACCOUNT.md Guide général tous fournisseurs 🟢 Débutant
GMAIL_EXAMPLE.md Tutorial Gmail complet 🟢 Débutant
GMAIL_SETUP.md Configuration Gmail OAuth2 🟡 Intermédiaire
MICROSOFT_SETUP.md Configuration Microsoft OAuth2 🟡 Intermédiaire

Déploiement Oracle Cloud

Document Description Niveau
ORACLE_ARM_QUICK_REF.md Référence rapide Oracle 🟡 Intermédiaire
ORACLE_ARM_SETUP_SUMMARY.md Résumé configuration Oracle 🟡 Intermédiaire

🔧 Documentation Technique

Localisation : docs/tech_doc/

Architecture & Développement

Document Description Niveau
CLAUDE.md Guide développeur complet 🔴 Avancé
AGENT.md Guide pour agents IA 🔴 Avancé
CHECKLIST.md Checklist développement 🟡 Intermédiaire

Connecteurs & Intégrations

Document Description Niveau
CONNECTOR_REFACTORING.md Architecture des connecteurs 🔴 Avancé
GMAIL_CONNECTOR.md Connecteur Gmail détaillé 🔴 Avancé
MICROSOFT_CONNECTOR.md Connecteur Microsoft détaillé 🔴 Avancé
INTEGRATIONS_STRUCTURE.md Structure des intégrations 🔴 Avancé

Phases de Développement

Document Description Niveau
PHASE_2_ACTIONS.md Système d'actions email 🔴 Avancé
BATCH_PROCESSING_PLAN.md Plan traitement batch 🔴 Avancé

Déploiement & Infrastructure

Document Description Niveau
DEPLOY_ORACLE_ARM.md Guide complet déploiement Oracle 🔴 Avancé
GITHUB_SETUP.md Configuration GitHub 🟡 Intermédiaire

Notes de Développement

Localisation : docs/tech_doc/notes/

Document Description Niveau
MIGRATION_SUMMARY.md Notes de migration 🟡 Intermédiaire
MICROSOFT_IMPLEMENTATION_SUMMARY.md Notes implémentation Microsoft 🟡 Intermédiaire
PHASE2_COMPLETION_SUMMARY.md Notes achèvement Phase 2 🟡 Intermédiaire

📄 Documents à la Racine

Essentiels

Document Description
README.md Vue d'ensemble du projet
CHANGELOG.md Historique des versions
CONTRIBUTING.md Guide de contribution

Gouvernance & Sécurité

Document Description
CODE_OF_CONDUCT.md Code de conduite
SECURITY.md Politique de sécurité
AUTHORS.md Liste des auteurs

🎯 Parcours par cas d'usage

Je veux déployer en production sur Oracle Cloud

Parcours recommandé :

  1. 📖 ORACLE_ARM_QUICK_REF.md - Lire en 5 min
  2. 🚀 scripts/deploy-oracle-arm.sh - Exécuter
  3. 📧 GMAIL_EXAMPLE.md - Ajouter premier compte
  4. 📊 ORACLE_ARM_SETUP_SUMMARY.md - Référence technique
  5. 🔧 DEPLOY_ORACLE_ARM.md - Guide technique complet

Temps total : 30-40 minutes

Je veux développer localement

Parcours recommandé :

  1. README.md - Vue d'ensemble
  2. docs/guides/QUICK_START.md - Installation
  3. docs/tech_doc/CLAUDE.md - Architecture détaillée
  4. docs/tech_doc/CONNECTOR_REFACTORING.md - Connecteurs

Je veux ajouter un compte email

Parcours recommandé :

  1. docs/guides/GMAIL_EXAMPLE.md - Si Gmail
  2. docs/guides/ADD_EMAIL_ACCOUNT.md - Si autre fournisseur
  3. scripts/README.md - Utilisation scripts

Je veux comprendre l'architecture technique

Parcours recommandé :

  1. docs/tech_doc/CLAUDE.md - Architecture globale
  2. docs/tech_doc/CONNECTOR_REFACTORING.md - Connecteurs
  3. docs/tech_doc/PHASE_2_ACTIONS.md - Système d'actions

🔍 Recherche par mot-clé

Gmail

Microsoft / Outlook

Oracle Cloud / ARM

Docker / Déploiement

Architecture / Développement

Sécurité

Tests

Scripts Utilitaires

📊 Architecture & Composants

Architecture globale

Document Niveau Description
docs/tech_doc/CLAUDE.md ⭐⭐⭐ Architecture complète
README.md ⭐ Vue d'ensemble simple
docs/guides/ORACLE_ARM_SETUP_SUMMARY.md ⭐⭐ Architecture déployée

Composants

Composant Documentation Code
API docs/tech_doc/CLAUDE.md api/
Workers docs/tech_doc/CLAUDE.md worker/
Connecteurs docs/tech_doc/CONNECTOR_REFACTORING.md shared/integrations/
Actions docs/tech_doc/PHASE_2_ACTIONS.md worker/actions/
Base de données docs/tech_doc/CLAUDE.md api/models.py

🆕 Nouveautés

Dernières mises à jour (2026-01-21)

Réorganisation Documentation :

  • Structure claire : docs/guides/ + docs/tech_doc/
  • Séparation guides utilisateur / documentation technique
  • Index mis à jour avec nouvelle structure

Phase 1 ✅ COMPLÉTÉE :

  • Connecteurs IMAP, Gmail, Microsoft implémentés
  • OAuth2 flows complets
  • Tests validés

Phase 2 ✅ COMPLÉTÉE :

  • Système de règles YAML
  • Actions automatiques (move, label, etc.)
  • Intégration Celery
  • Logging complet

Oracle ARM Optimization :

  • Configuration complète pour 24GB ARM
  • Scripts de déploiement automatique
  • Documentation dédiée
  • Optimisations PostgreSQL/Ollama

🎓 Niveau de difficulté

Guides d'utilisation

Document Niveau Temps lecture
docs/guides/QUICK_START.md 🟢 Débutant 5 min
docs/guides/GMAIL_EXAMPLE.md 🟢 Débutant 10 min
docs/guides/ORACLE_ARM_QUICK_REF.md 🟡 Intermédiaire 5 min
docs/guides/GMAIL_SETUP.md 🟡 Intermédiaire 15 min

Documentation technique

Document Niveau Temps lecture
docs/tech_doc/CLAUDE.md 🔴 Avancé 60 min
docs/tech_doc/CONNECTOR_REFACTORING.md 🔴 Avancé 30 min
docs/tech_doc/DEPLOY_ORACLE_ARM.md 🔴 Avancé 30 min
docs/tech_doc/PHASE_2_ACTIONS.md 🔴 Avancé 20 min

📞 Support

Par type de problème

Problème Document
Installation docs/guides/QUICK_START.md, docs/tech_doc/DEPLOY_ORACLE_ARM.md
Compte email docs/guides/GMAIL_EXAMPLE.md, docs/guides/ADD_EMAIL_ACCOUNT.md
Performance docs/guides/ORACLE_ARM_SETUP_SUMMARY.md
Développement docs/tech_doc/CLAUDE.md

✅ Checklist documentation

Pour utilisateurs :

Pour développeurs :

Pour déploiement Oracle :

Documentation maintenant organisée de manière claire et structurée ! 📚

Version : 2.0.0 Dernière mise à jour : 2026-01-21 Structure : docs/guides/ + docs/tech_doc/