🚀 Guide de Déploiement Mintlify

Guide étape par étape pour déployer votre documentation Enrow sur Mintlify.

📋 Prérequis

Compte GitHub (ou GitLab/Bitbucket)
Documentation complète dans /Users/thomaslucy/api-doc
Logos et images prêts (optionnel mais recommandé)

🎯 Étape 1: Initialiser Git Repository

1.1 Initialiser Git

cd /Users/thomaslucy/api-doc

# Initialiser le repository
git init

# Créer un .gitignore
cat > .gitignore << 'EOF'
# Node modules (si vous testez localement)
node_modules/
.mintlify/

# Environment variables
.env
.env.local

# OS files
.DS_Store
Thumbs.db

# Editor files
.vscode/
.idea/
*.swp
EOF

# Ajouter tous les fichiers
git add .

# Premier commit
git commit -m "Initial Enrow API documentation with Mintlify

- Complete API reference (Email Finder, Verifier, Phone)
- Integration guides (Clay, Cargo, Pronto, FullEnrich, Bettercontact)
- n8n playbooks with complete workflows
- Best practices and error handling guides"

🌐 Étape 2: Créer Repository GitHub

2.1 Via l’interface GitHub

Aller sur https://github.com
Cliquer sur ”+” → “New repository”
Nom: enrow-docs (ou autre)
Description: “Official Enrow API Documentation”
Visibilité: Private (recommandé) ou Public
NE PAS cocher “Initialize with README” (vous en avez déjà un)
Cliquer “Create repository”

2.2 Via GitHub CLI (alternatif)

# Installer GitHub CLI si pas déjà fait
# macOS: brew install gh
# Autres: https://cli.github.com

# Se connecter
gh auth login

# Créer le repo directement
gh repo create enrow-docs --private --source=. --remote=origin --push

2.3 Pousser le code manuellement

Si vous avez créé le repo via l’interface :

# Ajouter le remote
git remote add origin https://github.com/VOTRE-ORG/enrow-docs.git

# Renommer la branche en main
git branch -M main

# Pousser le code
git push -u origin main

Vérifier sur GitHub que tous les fichiers sont bien présents.

🎨 Étape 3: Ajouter les Images/Logos

3.1 Créer la structure

cd /Users/thomaslucy/api-doc

# Créer les dossiers publics
mkdir -p public/logo
mkdir -p public/images/logos
mkdir -p public/images/screenshots

3.2 Ajouter vos fichiers

Logo Enrow (obligatoire):

# Copier vos logos Enrow
cp /path/to/your/enrow-logo-light.svg public/logo/light.svg
cp /path/to/your/enrow-logo-dark.svg public/logo/dark.svg
cp /path/to/your/favicon.svg public/favicon.svg

Images hero (optionnel):

# Si vous avez des images pour l'intro
cp /path/to/hero-light.png public/images/hero-light.png
cp /path/to/hero-dark.png public/images/hero-dark.png

Logos partenaires (optionnel):

# Télécharger ou copier les logos des intégrations
# Clay, Cargo, etc.

3.3 Commit et push

git add public/
git commit -m "Add logos and images"
git push

🔗 Étape 4: Connecter à Mintlify

4.1 Créer un compte Mintlify

Aller sur https://mintlify.com
Cliquer “Sign Up” ou “Get Started”
Se connecter avec GitHub (recommandé)

4.2 Créer un nouveau projet

Dans le dashboard Mintlify, cliquer “New Documentation”
Sélectionner “Connect GitHub Repository”
Autoriser Mintlify à accéder à vos repos GitHub
Sélectionner le repository “enrow-docs”
Branche: main (ou votre branche par défaut)
Root directory: / (laisser vide si docs à la racine)
Cliquer “Connect”

4.3 Première build

Mintlify va automatiquement :

Détecter votre mint.json
Builder la documentation
Déployer sur un URL temporaire (ex: enrow-docs.mintlify.app)

Attendre 2-3 minutes pour la première build.

4.4 Vérifier le déploiement

Cliquer sur le lien fourni (ex: https://enrow-docs.mintlify.app)
Naviguer dans la doc
Vérifier que tout s’affiche correctement

Si erreurs :

Vérifier les logs dans Mintlify dashboard
Corriger les erreurs dans votre code
Push les corrections → Mintlify redéploie automatiquement

🌍 Étape 5: Configurer Domaine Personnalisé

5.1 Dans Mintlify

Aller dans Settings de votre projet
Section “Custom Domain”
Entrer: docs.enrow.io
Mintlify vous donnera un CNAME à configurer

5.2 Configurer DNS

Dans votre gestionnaire DNS (Cloudflare, Route53, etc.) : Ajouter un enregistrement CNAME :

Type: CNAME
Name: docs
Value: cname.mintlify.com  (ou la valeur fournie par Mintlify)
TTL: Auto ou 3600

Exemple Cloudflare :

Aller sur Cloudflare Dashboard
Sélectionner enrow.io
DNS → Add record
Type: CNAME
Name: docs
Target: cname.mintlify.com
Proxy status: DNS only (pas Proxied)
Save

5.3 Vérifier le domaine

Attendre la propagation DNS (5-30 minutes) puis :

# Vérifier le CNAME
dig docs.enrow.io CNAME

# Tester l'accès
curl -I https://docs.enrow.io

Votre documentation sera accessible sur https://docs.enrow.io !

🔄 Étape 6: Workflow de Mise à Jour

6.1 Modifier la documentation

cd /Users/thomaslucy/api-doc

# Modifier un fichier
# Par exemple: vim introduction.mdx

# Ajouter les changements
git add .
git commit -m "Update introduction with new features"
git push

6.2 Déploiement automatique

Mintlify déploie automatiquement à chaque push sur main :

Détecte le nouveau commit
Rebuild la documentation
Déploie en ~2 minutes

6.3 Prévisualiser avant merge

Pour prévisualiser des changements avant de merger :

Créer une branche

git checkout -b feature/new-playbook
# Faire vos modifications
git add .
git commit -m "Add new playbook"
git push -u origin feature/new-playbook

Dans Mintlify settings, activer “Deploy Preview Branches”
Mintlify créera une preview URL pour cette branche
Vérifier la preview
Merger dans main quand prêt

🧪 Étape 7: Test Local (Optionnel)

Pour tester localement avant de push :

7.1 Installer Mintlify CLI

# Installer Node.js si pas déjà fait
# macOS: brew install node
# Vérifier: node --version

# Installer Mintlify CLI
npm i -g mintlify

7.2 Lancer le serveur local

cd /Users/thomaslucy/api-doc

# Lancer le serveur de dev
mintlify dev

# Ouvrir http://localhost:3000

7.3 Hot reload

Les changements sont automatiquement reflétés quand vous modifiez les fichiers. Arrêter avec Ctrl+C.

⚙️ Étape 8: Configuration Avancée

8.1 Analytics

Dans mint.json, ajouter :

{
  "analytics": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    }
  }
}

8.2 Recherche

Mintlify active la recherche automatiquement. Pour personnaliser :

{
  "search": {
    "prompt": "Rechercher dans la documentation Enrow..."
  }
}

8.3 Versions (si besoin)

Pour gérer plusieurs versions de la doc :

{
  "versions": ["v1", "v2"]
}

Créer v1/mint.json et v2/mint.json.

8.4 Redirections

Pour rediriger d’anciennes URLs :

{
  "redirects": [
    {
      "source": "/old-page",
      "destination": "/new-page"
    }
  ]
}

📊 Étape 9: Monitoring

9.1 Dashboard Mintlify

Le dashboard Mintlify montre :

Analytics : Vues de pages, visiteurs
Build status : Succès/échecs des builds
Search queries : Ce que les gens recherchent
Broken links : Liens cassés détectés

9.2 Notifications

Configurer les notifications :

Settings → Notifications
Activer :
- Email sur build failed
- Slack webhook pour deployments

🐛 Troubleshooting

Build échoue

Erreur: Invalid mint.json

# Valider votre JSON
cat mint.json | jq .

Erreur: Fichier introuvable

Vérifier que tous les fichiers référencés dans mint.json existent
Vérifier les chemins (relatifs depuis la racine)

Images ne s’affichent pas

S’assurer que les images sont dans /public
Utiliser des chemins absolus : /images/logo.png
Vérifier que les fichiers sont bien pushés sur GitHub

Domaine personnalisé ne fonctionne pas

# Vérifier le CNAME
dig docs.enrow.io CNAME

# Devrait retourner: cname.mintlify.com

Si problème :

Attendre la propagation DNS (jusqu’à 48h)
Vérifier la configuration dans votre DNS
Contacter support Mintlify

📞 Support

Documentation Mintlify

Aide pour cette doc

README.md : Vue d’ensemble du projet
Fichiers .mdx : Modifier le contenu
mint.json : Modifier la structure/navigation

✅ Checklist Finale

Avant de lancer en production :

🎉 C’est Terminé !

Votre documentation Enrow est maintenant live sur https://docs.enrow.io ! Prochaines étapes :

Partager le lien avec votre équipe
Ajouter le lien dans votre app (https://app.enrow.io)
Annoncer sur vos réseaux sociaux
Collecter les feedbacks des utilisateurs
Améliorer continuellement

Besoin d’aide ? Contactez-moi ou le support Mintlify.

​🚀 Guide de Déploiement Mintlify

​📋 Prérequis

​🎯 Étape 1: Initialiser Git Repository

​1.1 Initialiser Git

​🌐 Étape 2: Créer Repository GitHub

​2.1 Via l’interface GitHub

​2.2 Via GitHub CLI (alternatif)

​2.3 Pousser le code manuellement

​🎨 Étape 3: Ajouter les Images/Logos

​3.1 Créer la structure

​3.2 Ajouter vos fichiers

​3.3 Commit et push

​🔗 Étape 4: Connecter à Mintlify

​4.1 Créer un compte Mintlify

​4.2 Créer un nouveau projet

​4.3 Première build

​4.4 Vérifier le déploiement

​🌍 Étape 5: Configurer Domaine Personnalisé

​5.1 Dans Mintlify

​5.2 Configurer DNS

​5.3 Vérifier le domaine

​🔄 Étape 6: Workflow de Mise à Jour

​6.1 Modifier la documentation

​6.2 Déploiement automatique

​6.3 Prévisualiser avant merge

​🧪 Étape 7: Test Local (Optionnel)

​7.1 Installer Mintlify CLI

​7.2 Lancer le serveur local

​7.3 Hot reload

​⚙️ Étape 8: Configuration Avancée

​8.1 Analytics

​8.2 Recherche

​8.3 Versions (si besoin)

​8.4 Redirections

​📊 Étape 9: Monitoring

​9.1 Dashboard Mintlify

​9.2 Notifications

​🐛 Troubleshooting

​Build échoue

​Images ne s’affichent pas

​Domaine personnalisé ne fonctionne pas

​📞 Support

​Documentation Mintlify

​Aide pour cette doc

​✅ Checklist Finale

​🎉 C’est Terminé !