Docusaurus

Synkronisera din Docusaurus-dokumentationssajt med AI SmartTalks kunskapsbas. Din AI kommer att lära sig från varje sida i din sitemap—perfekt för supportrobotar som svarar på tekniska frågor.

---

Översikt

Docusaurus-integrationen gör det möjligt för dig att:

• Importera alla sidor från din sitemap automatiskt
• Hålla dokumentationen synkroniserad när du publicerar uppdateringar
• Svara på frågor om din dokumentation konversativt
• Minska supportbelastningen genom att låta AI hantera vanliga frågor

Rolig fakta: AI SmartTalks egen dokumentation använder Docusaurus, och denna integration driver vår supportchattbot!

---

Förutsättningar

Innan du börjar, se till att du har:

• Ett aktivt AI SmartTalk-konto
• En Docusaurus-sajt med en giltig sitemap.xml
• Din sajt måste vara offentligt tillgänglig (eller tillhandahålla autentisering)

---

Steg-för-steg-installation

Steg 1: Lokalisera din Sitemap

Docusaurus genererar automatiskt en sitemap. Hitta den på:

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

Verifiera att den laddas i din webbläsare och innehåller dina dokumentationssidor.

Steg 2: Lägg till Docusaurus-integrationen

1. Logga in på ditt AI SmartTalk-konto
2. Navigera till Inställningar → Integrationer
3. Hitta Docusaurus och klicka på Anslut
4. Ange din sitemap-URL
5. Klicka på Validera

Steg 3: Konfigurera importinställningar

Efter validering, konfigurera din import:

Inställning	Beskrivning
Sitemap-URL	Fullständig URL till din sitemap.xml
Inkludera mönster	Endast synkronisera sidor som matchar mönster (valfritt)
Exkludera mönster	Hoppa över specifika sidor eller sektioner (valfritt)

Steg 4: Starta importen

1. Klicka på Importera sidor
2. AI SmartTalk genomsöker varje URL i din sitemap
3. Innehåll extraheras och läggs till din kunskapsbas
4. Vänta på att importen ska slutföras (framsteg visas)

Steg 5: Verifiera importen

1. Gå till Kunskap i AI SmartTalk
2. Dina dokumentationssidor bör visas
3. Testa din AI genom att ställa frågor om dina dokument

---

Vad som synkroniseras

Innehåll	Hur det bearbetas
Sidtitel	Används som dokumentidentifierare
Sidinnehåll	Fullständig text extraherad från HTML
Rubriker	Bevaras för struktur
Kodblock	Inkluderas som de är
Tabeller	Konverteras till läsbart format
URL:er	Sidans URL lagras för referens

Innehållsextraktion

AI SmartTalk extraherar huvudinnehållsområdet och ignorerar:

• Navigationsmenyer
• Sidofält
• Fötter
• Skript och stilar

---

Synkroniseringsbeteende

Manuell import

Klicka på Importera i integrationsinställningarna för att:

• Hämta den senaste sitemap
• Lägga till nya sidor
• Uppdatera ändrade sidor
• Ta bort raderade sidor

Hålla dokumentationen aktuell

För alltid aktuella dokument:

1. Manuell uppdatering: Klicka på Importera efter publicering av uppdateringar
2. Schemalagd synkronisering: Använd SmartFlow för att automatisera importer

SmartFlow Schemalagd 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-mönster

Inkludera mönster

Synkronisera endast specifika sektioner:

Mönster	Effekt
/docs/api/*	Endast API-dokumentation
/docs/guides/*	Endast guider
/blog/*	Endast blogginlägg

Exkludera mönster

Hoppa över vissa sidor:

Mönster	Effekt
/docs/internal/*	Hoppa över interna dokument
/changelog	Hoppa över changelog-sidan
*/draft-*	Hoppa över utkastssidor

---

Användningsfall

Teknisk supportbot

Synkronisera din produktdokumentation:

• "Hur installerar jag SDK:n?"
• "Vad är API:s hastighetsbegränsningar?"
• "Visa mig ett exempel på autentisering"

Utvecklardokumentation

Synkronisera API-referenser och guider:

• "Vilka parametrar accepterar /users-endpointen?"
• "Hur hanterar jag webbhooks?"
• "Vad är skillnaden mellan v1 och v2 API?"

Intern kunskapsbas

Synkronisera företagswikis och procedurer:

• "Vad är processen för att begära PTO?"
• "Hur sätter jag upp min utvecklingsmiljö?"
• "Var hittar jag varumärkesriktlinjerna?"

---

Felsökning

Sitemap-problem

Problem	Lösning
"Ogiltig sitemap"	Verifiera att URL:en returnerar giltig XML
"Inga sidor hittades"	Kontrollera att sitemap innehåller <url>-poster
"Åtkomst nekad"	Se till att sitemap är offentligt tillgänglig

Importproblem

Problem	Lösning
Sidor saknas	Kontrollera inkluderings-/exkluderingsmönster
Import fast	Stora sidor tar tid; vänta eller importera i omgångar
Gammalt innehåll	Återimportera för att hämta de senaste versionerna

Innehållskvalitet

Problem	Lösning
Felaktigt innehåll extraherat	Rapportera problemet—kan behöva anpassad extraktion
Saknade kodblock	Verifiera att koden är i standard <pre><code>-taggar
Otydlig text	Kontrollera sidkodning (UTF-8 rekommenderas)

---

Hantera integrationen

Åtgärd	Hur
Återimportera allt	Klicka på Importera i integrationsinställningarna
Ändra sitemap	Uppdatera URL och återimportera
Ta bort innehåll	Koppla bort integrationen eller ta bort från Kunskap
Koppla bort	Inställningar → Integrationer → Docusaurus → Koppla bort

---

Bästa praxis

1. Kvalitetsinnehåll: Välskrivna dokument = bättre AI-svar
2. Tydlig struktur: Använd rubriker, listor och tabeller
3. Beskrivande titlar: Sidtitlar hjälper AI att förstå kontext
4. Regelbundna synkroniseringar: Håll AI uppdaterad med den senaste dokumentationen
5. Testa noggrant: Ställ vanliga frågor för att verifiera AI:s noggrannhet

---

Docusaurus konfigurationstips

Optimera för AI-extraktion

I din docusaurus.config.js:

module.exports = {
  // Se till att sitemap genereras
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Använd beskrivande sidtitlar
  title: 'Din produktdokumentation',
  
  // Inkludera metadata
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentation för din produkt'
    }],
  },
};

Exkludera sidor från sitemap

För att förhindra att vissa sidor synkroniseras:

// I sidans frontmatter
---
title: Intern sida
sitemap:
  exclude: true
---

---

Relaterad dokumentation

• Översikt över integrationer
• Hantera kunskapsbas
• RSS-flödesintegration — För blogginnehåll/nyheter
• SmartFlow schemalagda utlösare — Automatisera importer