Documentation technique — Article1
Documentation technique — Article1
Index vivant. Mis à jour à chaque chantier significatif, pas en one-shot.
Plateformes
| Plateforme | Description | Docs |
|---|---|---|
| Article1 Connect | Hub SSO & gestion utilisateurs | → Documentation |
| Dema1n | Plateforme d'orientation professionnelle (NestJS + Nuxt) | → Documentation |
| Inspire V2 | Plateforme d'orientation éducative (NestJS + Quasar) | → Documentation |
Monorepo — docs transverses
| Fichier | Domaine |
|---|---|
| setup.md | Installation, URLs locales, bases de données, déploiement |
| git-workflow.md | Workflow Git par ticket, MEP et releases |
Points techniques
| Fichier | Domaine |
|---|---|
| sso | Flux SSO, JWT, sessions inter-plateformes |
| users-roles-permissions | Rôles utilisateurs et permissions |
| local-dev | Setup local, problèmes connus |
| infra | Docker, CI/CD, déploiement K8s |
| emailing | Emailing |
| frontend | Design system, composants, patterns Vue/Quasar/Nuxt |
| database | Schémas, migrations, cohérence cross-plateforme |
| crons | Crons |
| api | Routes NestJS, guards, conventions |
| rabbitmq-definitions | Defs RabbitMQ (rabbitmq-defs.json) — action manuelle staging/prod obligatoire |
Tutorials
| Fichier | Domaine |
|---|---|
| code-review.md | Grille de lecture pour la relecture de code |
| kubernetes.md | Lexique K8s et composants du cluster (Rancher, Longhorn, Kong...) |
| writing-documentation.md | Critères d'une bonne documentation |
| dbaccess.md | Accès aux bases de données |
Chantiers
| Fichier | Domaine |
|---|---|
| security.md | Rôles, guards, vulns connues, surface d'attaque |
| roadmap.md | Chantiers long terme planifiés |