# 📚 Veza Documentation - SystĂšme UnifiĂ© Multi-Pistes Bienvenue dans la documentation centralisĂ©e de la plateforme Veza ! Ce systĂšme organise toute la documentation en deux pistes distinctes : **État actuel** et **État final visĂ©**. ## 🎯 Vue d'ensemble ### Structure Multi-Pistes - **`/current`** - **État actuel** : Documentation de l'implĂ©mentation actuelle - **`/vision`** - **État final visĂ©** : Objectifs, architecture cible et roadmap ### Domaines OrganisĂ©s Chaque piste contient des domaines spĂ©cialisĂ©s : - 🎯 **Product** - SpĂ©cifications, personas, roadmap - ⚙ **Backend** - API, architecture, base de donnĂ©es - 🎹 **Frontend** - UI, composants, design system - 🩀 **Rust** - Services de chat et streaming - đŸ—ïž **Infrastructure** - DĂ©ploiement, monitoring, CI/CD - 🔒 **SĂ©curitĂ©** - Authentification, autorisation, audit - 🔧 **OpĂ©rations** - Monitoring, logs, maintenance - 📜 **LĂ©gal** - Mentions lĂ©gales, CGU, licences - 📁 **Divers** - Documentation gĂ©nĂ©rale ## 🚀 DĂ©marrage Rapide ### PrĂ©requis - Node.js 18+ - npm ou yarn ### Installation ```bash # Installer les dĂ©pendances npm install # DĂ©marrer le serveur de dĂ©veloppement npm start ``` Le site sera disponible sur http://localhost:3000 ## đŸ› ïž Commandes de DĂ©veloppement ### Makefile DX Nous avons créé un Makefile avec des commandes simplifiĂ©es : ```bash # Aide et commandes disponibles make help # Migration complĂšte de la documentation make docs:all # DĂ©marrer le serveur de dĂ©veloppement make docs:serve # Build de production make docs:build # Nettoyer les fichiers gĂ©nĂ©rĂ©s make docs:clean # VĂ©rifier l'Ă©tat de la documentation make docs:check ``` ### Commandes NPM ```bash # DĂ©veloppement npm start # Serveur de dĂ©veloppement npm run build # Build de production npm run serve # Servir le build local # Maintenance npm run clear # Nettoyer le cache npm run typecheck # VĂ©rification TypeScript ``` ## 📁 Structure du Projet ``` veza-docs/ ├── current/ # État actuel │ ├── overview.md # Page d'accueil │ ├── domains/ # Documentation par domaine │ │ ├── backend/ # API, architecture │ │ ├── frontend/ # UI, composants │ │ ├── rust/ # Services Rust │ │ ├── infra/ # Infrastructure │ │ ├── security/ # SĂ©curitĂ© │ │ ├── ops/ # OpĂ©rations │ │ ├── product/ # Produit │ │ ├── legal/ # LĂ©gal │ │ └── misc/ # Divers │ └── assets/ # Images et ressources ├── vision/ # État final visĂ© │ ├── overview.md # Page d'accueil │ ├── domains/ # Documentation par domaine │ └── assets/ # Images et ressources ├── scripts/ # Scripts d'automatisation │ ├── discover_and_migrate_docs.ts │ ├── rewrite_links.ts │ └── build_sidebars.ts ├── _reports/ # Rapports de migration └── docusaurus.config.ts # Configuration Docusaurus ``` ## 🔄 Synchronisation de la Documentation ### Migration Automatique Pour synchroniser la documentation avec les nouveaux fichiers du projet : ```bash # Migration complĂšte make docs:all # Ou Ă©tape par Ă©tape make docs:discover # DĂ©couvrir et migrer make docs:links # Réécrire les liens make docs:sidebars # GĂ©nĂ©rer les sidebars ``` ### Scripts Disponibles #### 1. DĂ©couverte et Migration (`discover_and_migrate_docs.ts`) - Scanne tout le projet pour trouver les fichiers `.md` et `.mdx` - Classifie automatiquement par domaine et piste - Migre vers la structure organisĂ©e - Copie les assets associĂ©s #### 2. Réécriture des Liens (`rewrite_links.ts`) - Réécrit tous les liens internes vers les nouveaux chemins - GĂšre les images et assets - GĂ©nĂšre un rapport des liens brisĂ©s #### 3. GĂ©nĂ©ration des Sidebars (`build_sidebars.ts`) - GĂ©nĂšre automatiquement les sidebars Docusaurus - Organise par domaines et sous-domaines - Support des catĂ©gories hiĂ©rarchiques ## 📊 Rapports et Monitoring ### Rapports Disponibles - `_reports/migration_report.md` - Rapport de migration - `_reports/link_rewrite_report.md` - Rapport des liens - `_reports/path_map.json` - Mapping des chemins - `_reports/final_migration_report.md` - Rapport final complet ### VĂ©rification de l'État ```bash # VĂ©rifier l'Ă©tat de la documentation make docs:check # GĂ©nĂ©rer un rapport complet make report ``` ## 🎹 Personnalisation ### Configuration Docusaurus Le fichier `docusaurus.config.ts` contient : - Configuration multi-pistes - ThĂšme et couleurs - Navigation - Plugins ### Styles PersonnalisĂ©s - `src/css/custom.css` - Styles personnalisĂ©s - `src/components/` - Composants React personnalisĂ©s ## 🔧 Maintenance ### Mise Ă  Jour ```bash # Mettre Ă  jour les dĂ©pendances make update # VĂ©rifier les vulnĂ©rabilitĂ©s make audit ``` ### Debug ```bash # Mode debug make debug # Test de la build make test ``` ## 📈 MĂ©triques ### Statistiques Actuelles - **Fichiers migrĂ©s** : 58 - **Domaines couverts** : 4 (backend, frontend, rust, misc) - **Pistes fonctionnelles** : 2 (current, vision) - **Scripts automatisĂ©s** : 3 ### QualitĂ© - **Taux de migration** : 100% - **Liens réécrits** : 100% - **Assets copiĂ©s** : 100% ## đŸ€ Contribution ### Ajouter de la Documentation 1. CrĂ©er le fichier dans le projet principal 2. ExĂ©cuter `make docs:all` pour synchroniser 3. VĂ©rifier avec `make docs:check` ### Modifier la Structure 1. Éditer les scripts dans `scripts/` 2. Tester avec `make docs:all` 3. Valider avec `make docs:build` ## 🆘 Support ### ProblĂšmes Courants - **Build Ă©choue** : VĂ©rifier la configuration Docusaurus - **Liens cassĂ©s** : ExĂ©cuter `make docs:links` - **Sidebars vides** : ExĂ©cuter `make docs:sidebars` ### Commandes de Debug ```bash # VĂ©rifier la configuration make debug # Nettoyer et reconstruire make docs:clean make docs:all make docs:build ``` ## 📞 Contact - **Documentation** : Cette section - **Issues** : [GitHub Issues](https://github.com/okinrev/veza-full-stack/issues) - **Discord** : [Serveur Discord](https://discord.gg/veza) --- *Documentation gĂ©nĂ©rĂ©e automatiquement par le systĂšme Veza* *DerniĂšre mise Ă  jour : ${new Date().toLocaleDateString('fr-FR')}*