Docusaurus

Synchroniseer uw Docusaurus-documentatiesite met de kennisbasis van AI SmartTalk. Uw AI leert van elke pagina in uw sitemap—perfect voor ondersteuningsbots die technische vragen beantwoorden.

---

Overzicht

De Docusaurus-integratie stelt u in staat om:

• Importeer automatisch alle pagina's van uw sitemap
• Houd docs gesynchroniseerd wanneer u updates publiceert
• Beantwoord vragen over uw documentatie op een conversatiële manier
• Verminder de ondersteuningslast door AI veelvoorkomende vragen te laten afhandelen

Leuk feit: De documentatie van AI SmartTalk zelf gebruikt Docusaurus, en deze integratie voedt onze ondersteuningschatbot!

---

Vereisten

Voordat u begint, zorg ervoor dat u:

• Een actief AI SmartTalk-account heeft
• Een Docusaurus-site met een geldige sitemap.xml
• Uw site moet openbaar toegankelijk zijn (of verstrek authenticatie)

---

Stapsgewijze Setup

Stap 1: Zoek uw Sitemap

Docusaurus genereert automatisch een sitemap. U vindt deze op:

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

Controleer of deze in uw browser laadt en uw documentatiepagina's bevat.

Stap 2: Voeg de Docusaurus-integratie toe

1. Log in op uw AI SmartTalk-account
2. Navigeer naar Instellingen → Integraties
3. Zoek Docusaurus en klik op Verbinden
4. Voer uw sitemap-URL in
5. Klik op Valideren

Stap 3: Configureer Importinstellingen

Na validatie, configureer uw import:

Instelling	Beschrijving
Sitemap URL	Volledige URL naar uw sitemap.xml
Inclusiepatronen	Alleen pagina's synchroniseren die overeenkomen met patronen (optioneel)
Exclusiepatronen	Sla specifieke pagina's of secties over (optioneel)

Stap 4: Start de Import

1. Klik op Pagina's Importeren
2. AI SmartTalk crawlt elke URL in uw sitemap
3. Inhoud wordt geëxtraheerd en toegevoegd aan uw kennisbasis
4. Wacht tot de import is voltooid (voortgang wordt weergegeven)

Stap 5: Verifieer de Import

1. Ga naar Kennis in AI SmartTalk
2. Uw documentatiepagina's zouden moeten verschijnen
3. Test uw AI door vragen te stellen over uw docs

---

Wat Wordt Gesynchroniseerd

Inhoud	Hoe Het Wordt Verwerkt
Paginatitel	Gebruikt als documentidentificator
Pagina-inhoud	Volledige tekst geëxtraheerd uit HTML
Koppen	Behouden voor structuur
Codeblokken	Inclusief zoals ze zijn
Tabellen	Omgezet naar leesbaar formaat
URLs	Pagina-URL opgeslagen voor referentie

Inhoud Extractie

AI SmartTalk extraheert het hoofdinhoudsgebied en negeert:

• Navigatiemenu's
• Zijbalken
• Voetteksten
• Scripts en stijlen

---

Synchronisatiegedrag

Handmatige Import

Klik op Importeren in de integratie-instellingen om:

• De nieuwste sitemap op te halen
• Nieuwe pagina's toe te voegen
• Gewijzigde pagina's bij te werken
• Verwijderde pagina's te verwijderen

Documenten Actueel Houden

Voor altijd actuele documentatie:

1. Handmatige verversing: Klik op Importeren na het publiceren van updates
2. Geplande synchronisatie: Gebruik SmartFlow om imports te automatiseren

SmartFlow Geplande Import

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

---

URL-patronen

Inclusiepatronen

Synchroniseer alleen specifieke secties:

Patroon	Effect
/docs/api/*	Alleen API-documentatie
/docs/guides/*	Alleen gidssectie
/blog/*	Alleen blogberichten

Exclusiepatronen

Sla bepaalde pagina's over:

Patroon	Effect
/docs/internal/*	Sla interne documentatie over
/changelog	Sla changelog-pagina over
*/draft-*	Sla conceptpagina's over

---

Gebruikscases

Technische Ondersteuningsbot

Synchroniseer uw productdocumentatie:

• "Hoe installeer ik de SDK?"
• "Wat zijn de API-snelheidslimieten?"
• "Toon me een voorbeeld van authenticatie"

Ontwikkelaarsdocumentatie

Synchroniseer API-referenties en gidsen:

• "Welke parameters accepteert de /users endpoint?"
• "Hoe ga ik om met webhooks?"
• "Wat is het verschil tussen v1 en v2 API?"

Interne Kennisbank

Synchroniseer bedrijfswiki's en procedures:

• "Wat is het proces voor het aanvragen van PTO?"
• "Hoe stel ik mijn ontwikkelomgeving in?"
• "Waar vind ik de merkrichtlijnen?"

---

Probleemoplossing

Sitemapproblemen

Probleem	Oplossing
"Ongeldige sitemap"	Controleer of de URL geldige XML retourneert
"Geen pagina's gevonden"	Controleer of de sitemap <url>-vermeldingen bevat
"Toegang geweigerd"	Zorg ervoor dat de sitemap openbaar toegankelijk is

Importproblemen

Probleem	Oplossing
Pagina's ontbreken	Controleer inclusie/exclusiepatronen
Import vastgelopen	Grote sites hebben tijd nodig; wacht of importeer in batches
Oude inhoud	Herimporteren om de nieuwste versies op te halen

Inhoudskwaliteit

Probleem	Oplossing
Verkeerde inhoud geëxtraheerd	Meld het probleem—mogelijk is aangepaste extractie nodig
Ontbrekende codeblokken	Controleer of de code in standaard <pre><code>-tags staat
Verstoorde tekst	Controleer de pagina-encoding (UTF-8 aanbevolen)

---

Beheer van de Integratie

Actie	Hoe
Herimporteer alles	Klik op Importeren in de integratie-instellingen
Verander sitemap	Werk de URL bij en herimporteer
Verwijder inhoud	Koppel de integratie los of verwijder uit Kennis
Ontkoppel	Instellingen → Integraties → Docusaurus → Ontkoppel

---

Best Practices

1. Kwaliteitsinhoud: Goed geschreven documentatie = betere AI-antwoorden
2. Duidelijke structuur: Gebruik koppen, lijsten en tabellen
3. Beschrijvende titels: Pagina titels helpen AI de context te begrijpen
4. Regelmatige synchronisaties: Houd AI up-to-date met de laatste documentatie
5. Grondig testen: Stel veelvoorkomende vragen om de nauwkeurigheid van de AI te verifiëren

---

Docusaurus Configuratie Tips

Optimaliseer voor AI Extractie

In uw docusaurus.config.js:

module.exports = {
  // Zorg ervoor dat de sitemap wordt gegenereerd
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Gebruik beschrijvende paginatitels
  title: 'Uw Productdocumentatie',
  
  // Inclusief metadata
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Documentatie voor Uw Product'
    }],
  },
};

Sluit Pagina's uit van Sitemap

Om te voorkomen dat bepaalde pagina's worden gesynchroniseerd:

// In pagina frontmatter
---
title: Interne Pagina
sitemap:
  exclude: true
---

---

Gerelateerde Documentatie

• Integraties Overzicht
• Kennisbank Beheer
• RSS Feed Integratie — Voor blog/nieuwsinhoud
• SmartFlow Geplande Triggers — Automatiseer imports