Hop til hovedindhold

Docusaurus

Synk din Docusaurus dokumentationsside ind i AI SmartTalks vidensbase. Din AI vil lære fra hver side i dit sitemap—perfekt til supportbots, der besvarer tekniske spørgsmål.


Oversigt​

Docusaurus-integrationen gør det muligt for dig at:

  • Importere alle sider fra dit sitemap automatisk
  • Holde dokumenter synkroniseret når du offentliggør opdateringer
  • Besvare spørgsmål om din dokumentation i en samtale
  • Reducere supportbelastningen ved at lade AI håndtere almindelige spørgsmål

Sjov fakta: AI SmartTalks egen dokumentation bruger Docusaurus, og denne integration driver vores support chatbot!


Forudsætninger​

Før du begynder, skal du sikre dig, at du har:

  • En aktiv AI SmartTalk-konto
  • En Docusaurus-side med et gyldigt sitemap.xml
  • Din side skal være offentligt tilgængelig (eller give autentificering)

Trin-for-trin Opsætning​

Trin 1: Find Dit Sitemap​

Docusaurus genererer automatisk et sitemap. Find det på:

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

Bekræft, at det indlæses i din browser og indeholder dine dokumentationssider.

Trin 2: Tilføj Docusaurus Integration​

  1. Log ind på din AI SmartTalk-konto
  2. Naviger til Indstillinger → Integrationer
  3. Find Docusaurus og klik på Forbind
  4. Indtast din sitemap-URL
  5. Klik på Valider

Trin 3: Konfigurer Importindstillinger​

Efter validering, konfigurer din import:

IndstillingBeskrivelse
Sitemap-URLFuld URL til dit sitemap.xml
Inkluder mønstreSynkroniser kun sider, der matcher mønstre (valgfrit)
Ekskluder mønstreSpring specifikke sider eller sektioner over (valgfrit)

Trin 4: Start Importen​

  1. Klik på Importer Sider
  2. AI SmartTalk crawler hver URL i dit sitemap
  3. Indholdet udtrækkes og tilføjes til din vidensbase
  4. Vent på, at importen er færdig (fremskridt vises)

Trin 5: Bekræft Importen​

  1. Gå til Viden i AI SmartTalk
  2. Dine dokumentationssider skal vises
  3. Test din AI ved at stille spørgsmål om dine dokumenter

Hvad Bliver Synkroniseret​

IndholdHvordan Det Behandles
Side titelBruges som dokumentidentifikator
SideindholdFuld tekst udtrukket fra HTML
OverskrifterBevares for struktur
KodeblokkeInkluderes som de er
TabellerKonverteres til læsbart format
URLsSide-URL gemmes til reference

Indholdsudtrækning​

AI SmartTalk udtrækker hovedindholdsområdet og ignorerer:

  • Navigationsmenuer
  • Sidebars
  • Footers
  • Scripts og stilarter

Synkroniseringsadfærd​

Manuel Import​

Klik på Importer i integrationsindstillingerne for at:

  • Hente det nyeste sitemap
  • Tilføje nye sider
  • Opdatere ændrede sider
  • Fjerne slettede sider

Holde Dokumenter Friske​

For altid aktuelle dokumentation:

  1. Manuel opdatering: Klik på Import efter offentliggørelse af opdateringer
  2. Planlagt synkronisering: Brug SmartFlow til at automatisere importer

SmartFlow Planlagt 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ønstre​

Inkluder Mønstre​

Synkroniser kun specifikke sektioner:

MønsterEffekt
/docs/api/*Kun API-dokumentation
/docs/guides/*Kun vejledningssektionen
/blog/*Kun blogindlæg

Ekskluder Mønstre​

Spring bestemte sider over:

MønsterEffekt
/docs/internal/*Spring interne dokumenter over
/changelogSpring changelog-siden over
*/draft-*Spring udkastssider over

Brugssager​

Teknisk Support Bot​

Synkroniser din produktdokumentation:

  • "Hvordan installerer jeg SDK'en?"
  • "Hvad er API-hastighedsgrænserne?"
  • "Vis mig et eksempel på autentificering"

Udviklerdokumentation​

Synkroniser API-referencer og vejledninger:

  • "Hvilke parametre accepterer /users-endpointet?"
  • "Hvordan håndterer jeg webhooks?"
  • "Hvad er forskellen mellem v1 og v2 API?"

Intern Vidensbase​

Synkroniser virksomhedens wikis og procedurer:

  • "Hvad er processen for at anmode om PTO?"
  • "Hvordan opsætter jeg mit udviklingsmiljø?"
  • "Hvor finder jeg brandretningslinjerne?"

Fejlfinding​

Sitemap Problemer​

ProblemLøsning
"Ugyldigt sitemap"Bekræft, at URL'en returnerer gyldig XML
"Ingen sider fundet"Tjek, at sitemap indeholder <url>-poster
"Adgang nægtet"Sørg for, at sitemap er offentligt tilgængeligt

Import Problemer​

ProblemLøsning
Sider manglerTjek inkluder/ekskluder mønstre
Import sidder fastStore sider tager tid; vent eller importer i portioner
Gammelt indholdRe-importer for at hente de nyeste versioner

Indholdskvalitet​

ProblemLøsning
Forkert indhold udtrukketRapportér problemet—kan kræve tilpasset udtrækning
Manglende kodeblokkeBekræft, at koden er i standard <pre><code> tags
Utydelig tekstTjek sidekodning (UTF-8 anbefales)

Håndtering af Integration​

HandlingHvordan
Re-importer alleKlik på Importer i integrationsindstillingerne
Ændre sitemapOpdater URL'en og re-importer
Fjern indholdAfbryd integrationen eller slet fra Viden
Afbryd forbindelseIndstillinger → Integrationer → Docusaurus → Afbryd

Bedste Praksis​

  1. Kvalitetsindhold: Veldokumenterede docs = bedre AI-svar
  2. Klar struktur: Brug overskrifter, lister og tabeller
  3. Beskrivende titler: Side titler hjælper AI med at forstå konteksten
  4. Regelmæssige synkroniseringer: Hold AI opdateret med den nyeste dokumentation
  5. Test grundigt: Stil almindelige spørgsmål for at bekræfte AI's nøjagtighed

Docusaurus Konfigurationstips​

Optimer til AI Uddragning​

I din docusaurus.config.js:

module.exports = {
// Sørg for, at sitemap genereres
plugins: ['@docusaurus/plugin-sitemap'],

// Brug beskrivende side titler
title: 'Din Produktdokumentation',

// Inkluder metadata
themeConfig: {
metadata: [{
name: 'description',
content: 'Dokumentation for Dit Produkt'
}],
},
};

Ekskluder Sider fra Sitemap​

For at forhindre visse sider i at blive synkroniseret:

// I side frontmatter
---
title: Intern Side
sitemap:
exclude: true
---

Relateret Dokumentation​

Klar til at løfte din
brugeroplevelse?

Implementer AI-assistenter, der glæder kunderne og skalerer med din virksomhed.

GDPR Overholdelse