Skip to main content

Déploiement de la documentation

État réel du flux docs

La documentation est dans docs/ (structure Mintlify + docs/docs.json + pages Markdown/MDX). Le flux actuel défini dans le code est :
  1. docs.yml s’exécute sur pull_request quand l’un des chemins suivis change (docs/**, package.json, package-lock.json, .github/workflows/docs.yml).
  2. Validation npm run docs:validate.
  3. Vérification des liens internes cassés npm run docs:links.
  4. Aucun déploiement automatique vers Mintlify dans ce workflow.

Configuration monorepo Mintlify

Dans Mintlify (pilotage dashboard), le dépôt doit pointer sur :
  • repository ymouafo/CEL
  • branche de travail projetée par votre règle GitHub
  • chemin docs docs
Ne pas ajouter de slash final.

Déploiement réel attendu vs docs obsolètes

  • Le contrôle CI docs est documenté dans le workflow.
  • La publication production reste manuelle côté plateforme docs (hors repository GitHub Actions).
  • Les anciennes formulations “prévu comme PR” / “étape production” doivent être lues comme préparatoires, pas comme exécution automatisée.

Déploiement technique (à réaliser côté dashboard)

  1. Créer/configurer le projet Mintlify.
  2. Connecter le dépôt GitHub ymouafo/CEL.
  3. Choisir la branche d’intégration (en cohérence avec la stratégie CI).
  4. Définir docs comme racine.
  5. Valider preview.
  6. Vérifier navigation et rendu.
  7. Configurer le domaine/publication finale.

Contrôles obligatoires pré-production

npm run docs:validate
npm run docs:links
Puis revue visuelle :
  • page d’accueil docs
  • navigation complète
  • rendering des blocs code
  • liens principaux
  • présence de pages clés métier

Domaines possibles (à arbitrer en infra)

  • sous-domaine Mintlify par défaut
  • sous-domaine dédié (docs.cel-eleague.com)
  • montage sur un chemin du site principal

Commandes de preview locale

npm run docs:dev

Références

  • DEPLOYMENT.md
  • README.md

Écarts doc↔code (retraits non faits ici)

  • Plusieurs docs historiques référençaient une séparation différente entre preview/prod docs ; le flux opérationnel réel est celui de docs.yml + pilotage Mintlify manuel.
  • docs/README et notes annexes peuvent encore mélanger “prévu”, “en place” et “déjà en prod” ; les écarts doivent être traités au prochain nettoyage doc.
Non vérifié (besoin d’info infra) :
  • Les domaines de production Mintlify effectivement choisis (docs.cel-eleague.com ou autre).
  • La présence d’un webhook de déclenchement/preview automatiques côté platforme Mintlify.
Last modified on June 24, 2026