Skip to main content

Utiliser Mintlify

Cette page explique comment travailler localement sur la documentation CEL avec Mintlify.

Pré-requis

Mintlify indique que la CLI nécessite Node.js 20.17.0 ou supérieur. Le repo CEL demande déjà Node.js 22 ou supérieur, donc le prérequis est compatible avec le projet.

Installer la CLI

npm i -g mint

Prévisualiser localement

Depuis la racine du repo :
npm run docs:dev
Ou directement depuis le dossier docs :
cd docs
mint dev
La preview locale est disponible sur :
http://localhost:3000

Vérifier la documentation

Depuis la racine du repo :
npm run docs:validate
npm run docs:links
Commandes Mintlify équivalentes depuis docs :
mint validate
mint broken-links

Organisation des pages

La navigation est définie dans :
docs/docs.json
Les pages doivent rester en français par défaut.

Règle de maintenance

Chaque PR qui modifie une règle métier importante doit mettre à jour la page de documentation correspondante. Exemples :
  • changement du schéma Convex : mettre à jour modele-donnees.md ;
  • changement des reports de match : mettre à jour matchs-reports-resultats.md ;
  • changement des transferts : mettre à jour transferts-mercato-premium.md ;
  • changement d’exploitation : mettre à jour runbook-exploitation.md.

Fichiers exclus

Le fichier .mintignore exclut les documents qui ne doivent pas être publiés dans le site Mintlify. Ne mets pas de brouillon, note interne ou fichier temporaire dans la navigation Mintlify.
Last modified on June 24, 2026