Docusaurus

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

---

Iwwerbléck

D'Docusaurus Integratioun erlaabt Iech:

• Importéieren all Säiten aus Ärem Sitemap automatesch
• Dokumenter synchroniséiert halen wann Dir Aktualisatiounen publizéiert
• Froen beäntweren iwwer Är Dokumentatioun op eng konversational Manéier
• Supportlast reduzéieren andeems AI d'gewéinlech Froen iwwerhëlt

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

---

Virbedingunge

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

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

---

Schrëtt-fir-Schrëtt Setup

Schrëtt 1: Fannt Ä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: Füügt d'Docusaurus Integratioun derbäi

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

Schrëtt 3: Konfiguréiert Import Astellungen

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: Start den Import

1. Klickt op Importéieren Säiten
2. AI SmartTalk crawlt all URL an Ärem Sitemap
3. De Inhalt gëtt extrahéiert an der Wëssenbasis bäigefüügt
4. Waart bis den Import ofgeschloss ass (Fortschrë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 Dokumenter stellt

---

Wat gëtt synchroniséiert

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

Inhaltsextraktioun

AI SmartTalk extrahéiert de haapte Inhalt Beräich an ignoréiert:

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

---

Sync Behavior

Manual Import

Klickt op Import an den Integratiounseinstellungen fir:

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

Keeping Docs Fresh

Fir ëmmer aktuell Dokumentatioun:

1. Manuell Erneierung: Klickt op Import nodeems Dir Aktualisatiounen verëffentlecht
2. Geplangte Synchronisatioun: Benotzt SmartFlow fir Importer ze automatiséieren

SmartFlow Scheduled Import

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

---

URL Patterns

Include Patterns

Nur spezifesch Sektiounen synchroniséieren:

Pattern	Effect
/docs/api/*	Nëmmen API Dokumentatioun
/docs/guides/*	Nëmmen Guides Sektioun
/blog/*	Nëmmen Blog Posts

Exclude Patterns

Bestëmmte Säiten überspringen:

Pattern	Effect
/docs/internal/*	Intern Dokumenter überspringen
/changelog	Changelog Säit überspringen
*/draft-*	Entworf Säiten überspringen

---

Use Cases

Technical Support Bot

Synchroniséiert Är Produktdokumentatioun:

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

Developer Documentation

Synchroniséiert API Referenzen an Guides:

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

Internal Knowledge Base

Synchroniséiert Firmenwikis an Prozeduren:

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

---

Troubleshooting

Sitemap Issues

Issue	Solution
"Invalid sitemap"	Verifizéiert datt d'URL valabel XML zréckgëtt
"No pages found"	Kontrolléiert ob d'Sitemap <url> Entréeën enthält
"Access denied"	Stellt sécher datt d'Sitemap ëffentlech zougänglech ass

Import Issues

Issue	Solution
Säiten feelen	Kontrolléiert d'Include/Exclude Patterns
Import fest	Grouss Säiten brauchen Zäit; waart oder importéiert an Chargen
Alen Inhalt	Re-importéiert fir d'lescht Versiounen ze kréien

Content Quality

Issue	Solution
Falschen Inhalt extrahéiert	Meldt d'Probleem—méi vläicht eng personaliséiert Extraktioun néideg
Fehlen Code Blöcke	Verifizéiert datt de Code an standard <pre><code> Tags ass
Gekritt Text	Kontrolléiert d'Page Encoding (UTF-8 empfohl)

---

Managing the Integration

Action	How
Re-import all	Klickt op Import an den Integratiounseinstellungen
Change sitemap	Aktualiséiert d'URL an re-importéiert
Remove content	Trennt d'Integratioun oder läscht et aus dem Knowledge
Disconnect	Settings → Integrations → Docusaurus → Disconnect

---

Bescht Praktiken

1. Qualitéitsinhalter: Gutt geschriwwen Dokumenter = besser AI Äntwerten
2. Klar Struktur: Benotzt Kapp, Lëschten, a 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. Grondlech testen: Froen déi dacks gestallt ginn, fir d'Genauegkeet vun der AI ze veriféieren

---

Docusaurus Konfiguratioun Tipps

Optimiséieren fir AI Extraktioun

An Ärem docusaurus.config.js:

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

Säiten aus dem Sitemap ausschléissen

Fir ze verhënneren, datt bestëmmte Säiten synchroniséiert ginn:

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

---

Verbonnen Dokumentatioun

• Integratiounen Iwwerbléck
• Wëssen Basis Management
• RSS Feed Integratioun — Fir Blog/Nachrichten Inhalt
• SmartFlow Geplangte Trigger — Automatiséiert Importer