Docusaurus

Synchronisez votre site de documentation Docusaurus dans la base de connaissances d'AI SmartTalk. Votre IA apprendra de chaque page de votre sitemap—parfait pour les bots de support qui répondent à des questions techniques.

---

Aperçu

L'intégration Docusaurus vous permet de :

• Importer automatiquement toutes les pages de votre sitemap
• Maintenir la synchronisation des docs lorsque vous publiez des mises à jour
• Répondre aux questions sur votre documentation de manière conversationnelle
• Réduire la charge de support en laissant l'IA gérer les questions courantes

Fait amusant : La documentation d'AI SmartTalk utilise Docusaurus, et cette intégration alimente notre chatbot de support !

---

Prérequis

Avant de commencer, assurez-vous d'avoir :

• Un compte AI SmartTalk actif
• Un site Docusaurus avec un sitemap.xml valide
• Votre site doit être accessible publiquement (ou fournir une authentification)

---

Configuration étape par étape

Étape 1 : Localiser votre Sitemap

Docusaurus génère automatiquement un sitemap. Trouvez-le à l'adresse :

https://your-docs-site.com/sitemap.xml

Vérifiez qu'il se charge dans votre navigateur et qu'il contient vos pages de documentation.

Étape 2 : Ajouter l'intégration Docusaurus

1. Connectez-vous à votre compte AI SmartTalk
2. Accédez à Paramètres → Intégrations
3. Trouvez Docusaurus et cliquez sur Connecter
4. Entrez l'URL de votre sitemap
5. Cliquez sur Valider

Étape 3 : Configurer les paramètres d'importation

Après validation, configurez votre importation :

Paramètre	Description
URL du Sitemap	URL complète de votre sitemap.xml
Modèles inclus	Synchroniser uniquement les pages correspondant à des modèles (optionnel)
Modèles exclus	Ignorer des pages ou sections spécifiques (optionnel)

Étape 4 : Démarrer l'importation

1. Cliquez sur Importer les pages
2. AI SmartTalk explore chaque URL de votre sitemap
3. Le contenu est extrait et ajouté à votre base de connaissances
4. Attendez la fin de l'importation (progrès affiché)

Étape 5 : Vérifier l'importation

1. Allez dans Connaissances dans AI SmartTalk
2. Vos pages de documentation devraient apparaître
3. Testez votre IA en posant des questions sur vos docs

---

Ce qui est synchronisé

Contenu	Comment il est traité
Titre de la page	Utilisé comme identifiant du document
Contenu de la page	Texte complet extrait du HTML
Titres	Préservés pour la structure
Blocs de code	Inclus tel quel
Tableaux	Convertis en format lisible
URLs	URL de la page stockée pour référence

Extraction de contenu

AI SmartTalk extrait la zone de contenu principal et ignore :

• Menus de navigation
• Barres latérales
• Pieds de page
• Scripts et styles

---

Comportement de synchronisation

Importation manuelle

Cliquez sur Importer dans les paramètres d'intégration pour :

• Récupérer le dernier sitemap
• Ajouter de nouvelles pages
• Mettre à jour les pages modifiées
• Supprimer les pages supprimées

Maintenir les docs à jour

Pour une documentation toujours actuelle :

1. Rafraîchissement manuel : Cliquez sur Importer après avoir publié des mises à jour
2. Synchronisation programmée : Utilisez SmartFlow pour automatiser les importations

Importation programmée SmartFlow

Workflow: Docusaurus Auto-Sync
Trigger: Scheduled (Daily at 3:00 AM)
Actions:
  - Sync Connector:
      Type: Docusaurus
      Sitemap: https://docs.example.com/sitemap.xml

---

Modèles d'URL

Modèles inclus

Synchronisez uniquement des sections spécifiques :

Modèle	Effet
/docs/api/*	Documentation API uniquement
/docs/guides/*	Section des guides uniquement
/blog/*	Articles de blog uniquement

Modèles exclus

Ignorez certaines pages :

Modèle	Effet
/docs/internal/*	Ignorer les docs internes
/changelog	Ignorer la page de changelog
*/draft-*	Ignorer les pages de brouillon

---

Cas d'utilisation

Bot de support technique

Synchronisez votre documentation produit :

• "Comment installer le SDK ?"
• "Quelles sont les limites de taux de l'API ?"
• "Montrez-moi un exemple d'authentification"

Documentation pour développeurs

Synchronisez les références et guides API :

• "Quels paramètres accepte le point de terminaison /users ?"
• "Comment gérer les webhooks ?"
• "Quelle est la différence entre l'API v1 et v2 ?"

Base de connaissances interne

Synchronisez les wikis et procédures de l'entreprise :

• "Quel est le processus pour demander un congé ?"
• "Comment configurer mon environnement de développement ?"
• "Où puis-je trouver les directives de la marque ?"

---

Dépannage

Problèmes de Sitemap

Problème	Solution
"Sitemap invalide"	Vérifiez que l'URL renvoie un XML valide
"Aucune page trouvée"	Vérifiez que le sitemap contient des entrées <url>
"Accès refusé"	Assurez-vous que le sitemap est accessible publiquement

Problèmes d'importation

Problème	Solution
Pages manquantes	Vérifiez les modèles inclus/exclus
Importation bloquée	Les grands sites prennent du temps ; attendez ou importez par lots
Ancien contenu	Réimportez pour récupérer les dernières versions

Qualité du contenu

Problème	Solution
Mauvais contenu extrait	Signalez le problème—une extraction personnalisée peut être nécessaire
Blocs de code manquants	Vérifiez que le code est dans des balises standard <pre><code>
Texte illisible	Vérifiez l'encodage de la page (UTF-8 recommandé)

---

Gestion de l'intégration

Action	Comment
Réimporter tout	Cliquez sur Importer dans les paramètres d'intégration
Changer le sitemap	Mettez à jour l'URL et réimportez
Supprimer le contenu	Déconnectez l'intégration ou supprimez-le de la connaissance
Déconnecter	Paramètres → Intégrations → Docusaurus → Déconnecter

---

Meilleures pratiques

1. Contenu de qualité : Des docs bien écrites = de meilleures réponses de l'IA
2. Structure claire : Utilisez des titres, des listes et des tableaux
3. Titres descriptifs : Les titres de page aident l'IA à comprendre le contexte
4. Synchronisations régulières : Gardez l'IA à jour avec la dernière documentation
5. Testez minutieusement : Posez des questions courantes pour vérifier l'exactitude de l'IA

---

Conseils de configuration Docusaurus

Optimiser pour l'extraction par l'IA

Dans votre docusaurus.config.js :

module.exports = {
  // Assurez-vous que le sitemap est généré
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Utilisez des titres de page descriptifs
  title: 'Documentation de votre produit',
  
  // Inclure des métadonnées
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Documentation pour votre produit'
    }],
  },
};

Exclure des pages du Sitemap

Pour empêcher certaines pages d'être synchronisées :

// Dans le frontmatter de la page
---
title: Page interne
sitemap:
  exclude: true
---

---

Documentation connexe

• Aperçu des intégrations
• Gestion de la base de connaissances
• Intégration de flux RSS — Pour le contenu de blog/actualités
• Déclencheurs programmés SmartFlow — Automatiser les importations