Docusaurus

Synchroniséiert Är Docusaurus Dokumentatiounsseite an d'Wëssenbasis vun AI SmartTalk. Äre AI wäert vun all Säit an Ärem Sitemap léieren—perfekt fir Supportbots déi technesch Froen beäntweren.

---

Iwwerbléck

D'Docusaurus Integratioun erlaabt Iech:

• Importéieren all Säiten aus Ärem Sitemap automatesch
• Halten Docs synchron wann Dir Updates publizéiert
• Beäntwerten Froen iwwer Är Dokumentatioun konversational
• Reduzéieren Supportlast andeems AI d'gewéinlech Froen behandelt

Witzeg Fakt: D'Dokumentatioun vun AI SmartTalk benotzt Docusaurus, an dës Integratioun ënnerstëtzt eisen Support Chatbot!

---

Viraussetzungen

E ier Dir ufänkt, stellt sécher datt Dir hutt:

• E aktive AI SmartTalk Kont
• Eng Docusaurus Säit mat engem gültege sitemap.xml
• Är Säit muss ëffentlech zougänglech sinn (oder Authentifikatioun ubidden)

---

Schrëtt-fir-Schrëtt Setup

Schrëtt 1: Fannen Ären Sitemap

Docusaurus generéiert automatesch e Sitemap. Fannt et op:

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

Verifizéiert datt et an Ärem Browser läd an Är Dokumentatiounssäiten enthält.

Schrëtt 2: D'Docusaurus Integratioun derbäisetzen

1. Loggt Iech an Ärem AI SmartTalk Kont an
2. Navigéiert op Einstellungen → Integratiounen
3. Fannt Docusaurus a klickt op Verbannen
4. Gitt Ären Sitemap URL an
5. Klickt op Validéieren

Schrëtt 3: Import Astellungen konfiguréieren

No der Validatioun, konfiguréiert Ären Import:

Astellung	Beschreiwung
Sitemap URL	Voll URL zu Ärem sitemap.xml
Include patterns	Nëmmen Säiten synchroniséieren déi mat Musteren übereenstëmmen (optional)
Exclude patterns	Bestëmmte Säiten oder Sektiounen ausloossen (optional)

Schrëtt 4: Starten den Import

1. Klickt op Importéieren
2. AI SmartTalk crawlt all URL an Ärem Sitemap
3. Inhalter ginn extrahéiert an der Wëssenbasis bäigefüügt
4. Waart bis den Import fäerdeg ass (Fortschrëtt gëtt gewisen)

Schrëtt 5: Verifizéiert den Import

1. Geet op Wëssen an AI SmartTalk
2. Är Dokumentatiounssäiten sollten erschéngen
3. Testt Äre AI andeems Dir Froen iwwer Är Docs stellt

---

Wat gëtt synchroniséiert

Inhalt	Wéi et veraarbecht gëtt
Säit Titel	Benotzt als Dokument Identifikator
Säit Inhalt	Voll Text extrahéiert aus HTML
Überschriften	Bewahrt fir Struktur
Code Blöcke	Inkludéiert wéi se sinn
Tabellen	Konvertéiert an e liesbare Format
URLs	Säit URL gespäichert fir Referenz

Inhaltsextraktioun

AI SmartTalk extrahéiert den Haaptinhalt Beräich an ignoréiert:

• Navigatiounsmenüen
• Sidebaren
• Fousszeilen
• Skripter an Stiler

---

Synchronisatiounsverhalen

Manuell Import

Klickt op Importéieren an den Integratiouns Astellungen fir:

• D'lescht Sitemap ze kréien
• Nei Säiten derbäizefügen
• Geännert Säiten ze aktualiséieren
• Geläscht Säiten ze läschen

Halen Docs Frësch

Fir ëmmer aktuell Dokumentatioun:

1. Manuell Erneierung: Klickt op Importéieren nodeems Dir Updates publizéiert
2. Plangéiert Synchronisatioun: Benotzt SmartFlow fir Importer ze automatiséieren

SmartFlow Plangéiert Import

Workflow: Docusaurus Auto-Sync
Trigger: Plangéiert (All Dag um 3:00 Auer)
Actions:
  - Sync Connector:
      Type: Docusaurus
      Sitemap: https://docs.example.com/sitemap.xml

---

URL Musteren

Include Musteren

Nëmmen spezifesch Sektiounen synchroniséieren:

Muster	Effekt
/docs/api/*	Nëmmen API Dokumentatioun
/docs/guides/*	Nëmmen Guides Sektioun
/blog/*	Nëmmen Blog Posts

Exclude Musteren

Bestëmmte Säiten ausloossen:

Muster	Effekt
/docs/internal/*	Skip intern Docs
/changelog	Skip Changelog Säit
*/draft-*	Skip Entworf Säiten

---

Benotzungsfäll

Technesch Support Bot

Synchroniséiert Är Produkt Dokumentatioun:

• "Wéi installéieren ech de SDK?"
• "Wat sinn d'API Rate Limiten?"
• "Wéi eng Beispill vun Authentifikatioun?"

Entwéckler Dokumentatioun

Synchroniséiert API Referenzen an Guides:

• "Wéi eng Parameter akzeptéiert de /users Endpoint?"
• "Wéi geet ech mat Webhooks ëm?"
• "Wat ass den Ënnerscheed tëscht v1 an v2 API?"

Intern Wëssenbasis

Synchroniséiert Firmen Wikis an Prozeduren:

• "Wat ass de Prozess fir PTO ze froen?"
• "Wéi richteg ech mengt Entwécklungsëmfeld?"
• "Wou fannen ech d'Brand Richtlinnen?"

---

Problemer Léisung

Sitemap Problemer

Probleem	Léisung
"Invalid sitemap"	Verifizéiert datt d'URL gültegt XML zréckgëtt
"No pages found"	Kontrolléiert datt de Sitemap <url> Entréeën enthält
"Access denied"	Stellt sécher datt de Sitemap ëffentlech zougänglech ass

Import Problemer

Probleem	Léisung
Säiten feelen	Kontrolléiert Include/Exclude Musteren
Import fest	Grouss Säiten brauchen Zäit; waart oder importéiert an Chargen
Al Inhalt	Re-importéiert fir déi lescht Versiounen ze kréien

Inhalt Qualitéit

Probleem	Léisung
Falschen Inhalt extrahéiert	Rapportéiert d'Probleem—méi vläicht personaliséiert Extraktioun néideg
Fehlen Code Blöcke	Verifizéiert datt de Code an standard <pre><code> Tags ass
Gekräizten Text	Kontrolléiert d'Page Kodéierung (UTF-8 empfohl)

---

Verwalten vun der Integratioun

Aktioun	Wéi
All re-importéieren	Klickt op Importéieren an den Integratiouns Astellungen
Ändert Sitemap	Aktualiséiert d'URL an re-importéiert
Inhalt läschen	Trennt Integratioun oder läscht aus Wëssen
Trennen	Astellungen → Integratiounen → Docusaurus → Trennen

---

Bescht Praktiken

1. Qualitéitsinhalt: Gutt geschriwwe Docs = besser AI Äntwerten
2. Klar Struktur: Benotzt Überschriften, Listen, an Tabellen
3. Beschreiwende Titelen: Säit Titelen hëllefen AI den Kontext ze verstoen
4. Regelméisseg Synchronisatiounen: Hält AI aktualiséiert mat der leschter Dokumentatioun
5. Testt grëndlech: Froen déi gewéinlech sinn fir d'AI Genauegkeet ze verifizieren

---

Docusaurus Konfiguratioun Tipps

Optimiséiert fir AI Extraktioun

An Ärem docusaurus.config.js:

module.exports = {
  // Stellt sécher datt de Sitemap generéiert gëtt
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Benotzt beschreiwende Säit Titelen
  title: 'Är Produkt Docs',
  
  // Enthält Metadaten
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentatioun fir Äert Produkt'
    }],
  },
};

Säiten aus dem Sitemap ausschléissen

Fir bestëmmte Säiten aus der Synchronisatioun ze verhënneren:

// An der Säit Frontmatter
---
title: Intern Säit
sitemap:
  exclude: true
---

---

Verwandte Dokumentatioun

• Integratiounen Iwwerbléck
• Wëssenbasis Verwalten
• RSS Feed Integratioun — Fir Blog/Nachrichten Inhalt
• SmartFlow Plangéiert Trigger — Automatiséiert Importer