Skip to content

INDEX.md

Latest commit

 

History

History
197 lines (147 loc) · 4.84 KB

INDEX.md

File metadata and controls

197 lines (147 loc) · 4.84 KB
Raw

📚 Index de la Documentation - ExpandProject

Bienvenue dans ExpandProject! Ce fichier vous guide vers la bonne documentation selon vos besoins.

🎯 Je veux...

... Démarrer Rapidement (< 5 minutes)

→ START_HERE.md - 3 commandes pour tester

mvn clean install
java -jar importdata/target/expandproject-importdata.jar --example

... Comprendre le Projet

→ README.md - Vue d'ensemble complète

  • Fonctionnalités
  • Architecture
  • Installation détaillée
  • Troubleshooting

→ RELEASE_NOTES.md - Notes de version

  • Nouvelles fonctionnalités
  • Mises à jour techniques
  • Roadmap

→ SUMMARY.md - Résumé des modifications

  • Ce qui a été fait
  • Avant/Après
  • Résultats

... Installer et Utiliser

→ QUICKSTART.md - Guide de démarrage rapide

  • Installation pas à pas
  • Premiers tests
  • Exemples de modèles
  • Requêtes Cypher de base

Scripts fournis:

  • run-example.sh - Test rapide
  • run-import.sh - Import avec validations

... Développer et Intégrer

→ ADVANCED_USAGE.md - Utilisation avancée

  • API Java complète
  • Validation programmatique
  • Connecteurs personnalisés
  • Requêtes Cypher avancées
  • Extensions et plugins

→ SYSTEM_MODEL_DOCUMENTATION.md - Documentation technique

  • Architecture du système
  • Schémas XSD détaillés
  • Génération des DTOs
  • Classes Java générées

... Voir les Changements

→ CHANGELOG_UPDATE.md - Historique détaillé

  • Mises à jour des dépendances
  • Modifications de code
  • Corrections de sécurité

📋 Documentation par Module

Module Commons

→ commons/README.md

  • Classes utilitaires
  • Constantes
  • Enums

Module ImportData

→ importdata/README.md

  • Module principal
  • API d'import
  • Connecteurs DB

Module Model

→ model/README.md

  • Module modèle (vide actuellement)

🗺️ Structure de la Documentation

Documentation/
│
├── 🚀 Démarrage
│   ├── START_HERE.md          ⭐ Commencez ici!
│   ├── QUICKSTART.md          5-10 minutes
│   └── README.md              Guide complet
│
├── 🧑‍💻 Développement
│   ├── ADVANCED_USAGE.md      API et cas avancés
│   └── SYSTEM_MODEL_DOCUMENTATION.md  Architecture
│
├── 📋 Référence
│   ├── RELEASE_NOTES.md       Notes de version
│   ├── CHANGELOG_UPDATE.md    Historique
│   └── SUMMARY.md             Résumé
│
└── 📖 Vous êtes ici
    └── INDEX.md               Ce fichier

🎓 Parcours Recommandé

Débutant Complet

  1. START_HERE.md - Comprendre les bases
  2. Exécuter : java -jar ... --example
  3. QUICKSTART.md - Créer votre premier modèle
  4. README.md - Approfondir

Utilisateur Technique

  1. README.md - Vue d'ensemble
  2. QUICKSTART.md - Installation
  3. Tester avec vos données
  4. ADVANCED_USAGE.md - Optimiser

Développeur

  1. SYSTEM_MODEL_DOCUMENTATION.md - Architecture
  2. ADVANCED_USAGE.md - API Java
  3. Code source - Explorer les classes
  4. Contribuer - Suivre README.md section Contribution

🔍 Recherche Rapide

Je cherche...

Quoi Où
Commandes de démarrage START_HERE.md
Installation Neo4j QUICKSTART.md, README.md
Syntaxe XML du modèle README.md, SYSTEM_MODEL_DOCUMENTATION.md
Exemples de modèles importdata/src/main/resources/model/
Exemples de données importdata/src/main/resources/datapack/
API Java ADVANCED_USAGE.md
Requêtes Cypher QUICKSTART.md, ADVANCED_USAGE.md
Configuration Neo4j README.md section Configuration
Troubleshooting README.md section Dépannage
Validation des données ADVANCED_USAGE.md section Validation
Types de données README.md, SYSTEM_MODEL_DOCUMENTATION.md
Scripts shell run-example.sh, run-import.sh
Architecture SYSTEM_MODEL_DOCUMENTATION.md
Changelog CHANGELOG_UPDATE.md
Release notes RELEASE_NOTES.md

📞 Besoin d'Aide ?

  1. Consultez le fichier approprié ci-dessus
  2. Cherchez dans la documentation (Ctrl+F)
  3. Testez avec --example
  4. Ouvrez une issue sur GitHub

✅ Checklist de Démarrage

  • Lire START_HERE.md
  • Compiler : mvn clean install
  • Tester : java -jar ... --example
  • Installer Neo4j (Docker ou local)
  • Importer les données d'exemple
  • Visualiser dans Neo4j Browser
  • Créer votre premier modèle
  • Valider vos données
  • Importer en production

Bonne lecture et bon développement! 🚀