​

🚀 Guide de Déploiement 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

1. Aller sur https://github.com
2. Cliquer sur ”+” → “New repository”
3. Nom: enrow-docs (ou autre)
4. Description: “Official Enrow API Documentation”
5. Visibilité: Private (recommandé) ou Public
6. NE PAS cocher “Initialize with README” (vous en avez déjà un)
7. 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

# 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

​

🎨 É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

# 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

# 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

# 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

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

​

4.2 Créer un nouveau projet

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

​

4.3 Première build

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

​

4.4 Vérifier le déploiement

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

• 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

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

​

5.2 Configurer DNS

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

1. Aller sur Cloudflare Dashboard
2. Sélectionner enrow.io
3. DNS → Add record
4. Type: CNAME
5. Name: docs
6. Target: cname.mintlify.com
7. Proxy status: DNS only (pas Proxied)
8. Save

​

5.3 Vérifier le domaine

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

# Tester l'accès
curl -I 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

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

​

6.3 Prévisualiser avant merge

1. 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

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

​

🧪 Étape 7: Test Local (Optionnel)

​

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

​

⚙️ Étape 8: Configuration Avancée

​

8.1 Analytics

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

​

8.2 Recherche

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

​

8.3 Versions (si besoin)

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

​

8.4 Redirections

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

​

📊 Étape 9: Monitoring

​

9.1 Dashboard Mintlify

• 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

1. Settings → Notifications
2. Activer :
   • Email sur build failed
   • Slack webhook pour deployments

​

🐛 Troubleshooting

​

Build échoue

# Valider votre JSON
cat mint.json | jq .

• 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

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

​

📞 Support

​

Documentation Mintlify

• Docs: https://mintlify.com/docs
• Discord: https://mintlify.com/discord
• Email: support@mintlify.com

​

Aide pour cette doc

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

​

✅ Checklist Finale

• Tous les fichiers sont pushés sur GitHub
• Logos et images ajoutés dans /public
• Build Mintlify réussie
• Documentation accessible sur URL Mintlify
• Domaine personnalisé configuré (docs.enrow.io)
• HTTPS fonctionnel
• Navigation testée (tous les liens fonctionnent)
• Code examples vérifiés
• Analytics configurés (optionnel)
• Search fonctionne

​

🎉 C’est Terminé !

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