Docusaurus

Synchroniséiert Är Docusaurus Dokumentatiounsseite an d'Wëssenbasis vum AI SmartTalk. Äre AI léiert vun all Säit an Ärem Sitemap—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
• Dokumenter synchroniséiert halen wann Dir Updates verëffentlecht
• Froen beäntweren iwwer Är Dokumentatioun konversational
• Supportlast reduzéieren andeems AI d'gemeinsam Froen iwwerhëlt

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

---

Viraussetzungen

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

• Eng aktiv 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 hei:

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

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

Schrëtt 2: Füügt d'Docusaurus Integratioun derbäi

1. Loggt Iech an Ärem AI SmartTalk Kont an
2. Navigéiert op Astellungen → 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. Inhalter ginn 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. Geht op Wëssen am 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äitleit	Benotzt als Dokumentidentifikator
Säiteninhalt	Voll Text extrahéiert aus HTML
Ünnertitel	Bewahrt fir Struktur
Codebléck	Inkludéiert wéi et ass
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
• Skripten an Stiler

---

Sync Behavior

Manual Import

Klickt op Import an den Integratiounsparameter 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

Keeping Docs Fresh

Fir ëmmer aktuell Dokumentatioun:

1. Manuell Erneierung: Klickt op Import nodeems Dir Aktualiséierungen 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

Nëmmen 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 iwwerhuelen:

Pattern	Effect
/docs/internal/*	Iwwerhuelen intern Dokumenter
/changelog	Iwwerhuelen Changelog Säit
*/draft-*	Iwwerhuelen Entworf Säiten

---

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 fir Authentifikatioun?"

Developer Documentation

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?"

Internal Knowledge Base

Synchroniséiert Firmenwikis an Prozeduren:

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

---

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
Al 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 Codebléck	Verifizéiert datt de Code an de standard <pre><code> Tags ass
Gekräizte Text	Kontrolléiert d'Page Encoding (UTF-8 recommandéiert)

---

Managing the Integration

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

---

Best Practices

1. Qualité Inhalter: Gutt geschriwwen Dokumentatioun = besser AI Äntwerten
2. Klar Struktur: Benotzt Kapp, Lëschten, a Tabellë
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. Grëndlech testen: Froen déi dacks gestallt ginn fir AI Genoss ze veriféieren

---

Docusaurus Konfiguratioun Tipps

Optimiséieren fir AI Extraktioun

An Ärem docusaurus.config.js:

module.exports = {
  // Ensure sitemap is generated
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Use descriptive page titles
  title: 'Your Product Docs',
  
  // Include metadata
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Documentation for Your Product'
    }],
  },
};

Säiten aus der Sitemap ausschléissen

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

// In page frontmatter
---
title: Internal Page
sitemap:
  exclude: true
---

---

Verbonnen Dokumentatioun

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