Hopp til hovedinnhold

Docusaurus

Synkroniser dokumentasjonsnettstedet ditt i Docusaurus med AI SmartTalks kunnskapsbase. Din AI vil lære fra hver side i nettstedskartet ditt—perfekt for supportboter som svarer på tekniske spørsmål.


Oversikt

Docusaurus-integrasjonen lar deg:

  • Importere alle sider fra nettstedskartet ditt automatisk
  • Holde dokumentene synkronisert når du publiserer oppdateringer
  • Svare på spørsmål om dokumentasjonen din på en samtalepreget måte
  • Redusere supportbelastningen ved å la AI håndtere vanlige spørsmål

Morsom fakta: AI SmartTalks egen dokumentasjon bruker Docusaurus, og denne integrasjonen driver vår supportchatbot!


Forutsetninger

Før du begynner, må du sørge for at du har:

  • En aktiv AI SmartTalk-konto
  • Et Docusaurus-nettsted med et gyldig sitemap.xml
  • Nettstedet ditt må være offentlig tilgjengelig (eller gi autentisering)

Trinn-for-trinn-oppsett

Trinn 1: Finn nettstedskartet ditt

Docusaurus genererer automatisk et nettstedskart. Finn det på:

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

Bekreft at det lastes inn i nettleseren din og inneholder dokumentasjonssidene dine.

Trinn 2: Legg til Docusaurus-integrasjonen

  1. Logg inn på AI SmartTalk-kontoen din
  2. Naviger til InnstillingerIntegrasjoner
  3. Finn Docusaurus og klikk Koble til
  4. Skriv inn URL-en til nettstedskartet ditt
  5. Klikk Valider

Trinn 3: Konfigurer importinnstillinger

Etter validering, konfigurer importen din:

InnstillingBeskrivelse
Nettstedkart-URLFull URL til nettstedskartet ditt sitemap.xml
Inkluder mønstreBare synkroniser sider som matcher mønstre (valgfritt)
Ekskluder mønstreHopp over spesifikke sider eller seksjoner (valgfritt)

Trinn 4: Start importen

  1. Klikk Importer sider
  2. AI SmartTalk gjennomgår hver URL i nettstedskartet ditt
  3. Innholdet blir hentet og lagt til kunnskapsbasen din
  4. Vent på at importen skal fullføres (fremdrift vises)

Trinn 5: Bekreft importen

  1. Gå til Kunnskap i AI SmartTalk
  2. Dokumentasjonssidene dine skal vises
  3. Test AI-en din ved å stille spørsmål om dokumentene dine

Hva som blir synkronisert

InnholdHvordan det behandles
Side tittelBrukes som dokumentidentifikator
SideinnholdFull tekst hentet fra HTML
OverskrifterBeholdt for struktur
KodeblokkerInkludert som de er
TabellerKonvertert til lesbart format
URL-erSide-URL lagret for referanse

Innhentingsprosess

AI SmartTalk henter hovedinnholdsområdet og ignorerer:

  • Navigasjonsmenyer
  • Sidefelt
  • Bunntekster
  • Skript og stiler

Synkroniseringsatferd

Manuell Import

Klikk Import i integrasjonsinnstillingene for å:

  • Hente den nyeste nettstedsoversikten
  • Legge til nye sider
  • Oppdatere endrede sider
  • Fjerne slettede sider

Holde Dokumentasjonen Oppdatert

For alltid oppdatert dokumentasjon:

  1. Manuell oppdatering: Klikk Import etter å ha publisert oppdateringer
  2. Planlagt synkronisering: Bruk SmartFlow for å 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 spesifikke seksjoner:

MønsterEffekt
/docs/api/*Kun API-dokumentasjon
/docs/guides/*Kun veiledningsseksjonen
/blog/*Kun blogginnlegg

Ekskluder Mønstre

Hopp over bestemte sider:

MønsterEffekt
/docs/internal/*Hopp over interne dokumenter
/changelogHopp over endringslogg-siden
*/draft-*Hopp over utkast-sider

Bruksområder

Teknisk Støtte Bot

Synkroniser produktdokumentasjonen din:

  • "Hvordan installerer jeg SDK-en?"
  • "Hva er API-hastighetsgrensene?"
  • "Vis meg et eksempel på autentisering"

Utviklerdokumentasjon

Synkroniser API-referanser og veiledninger:

  • "Hvilke parametere aksepterer /users-endepunktet?"
  • "Hvordan håndterer jeg webhooks?"
  • "Hva er forskjellen mellom v1 og v2 API?"

Intern Kunnskapsbase

Synkroniser bedrifts-wikier og prosedyrer:

  • "Hva er prosessen for å be om PTO?"
  • "Hvordan setter jeg opp utviklingsmiljøet mitt?"
  • "Hvor finner jeg retningslinjene for merkevaren?"

Feilsøking

Nettstedsoversiktsproblemer

ProblemLøsning
"Ugyldig nettstedsoversikt"Bekreft at URL-en returnerer gyldig XML
"Ingen sider funnet"Sjekk at nettstedsoversikten inneholder <url>-oppføringer
"Tilgang nektet"Sørg for at nettstedsoversikten er offentlig tilgjengelig

Importproblemer

ProblemLøsning
Sider manglerSjekk inkluder/ekskluder mønstre
Importen sitter fastStore nettsteder tar tid; vent eller importer i batcher
Gammelt innholdRe-importer for å hente de nyeste versjonene

Innholdskvalitet

ProblemLøsning
Feil innhold hentetRapportér problemet—kan trenge tilpasset ekstraksjon
Manglende kodeblokkerBekreft at koden er i standard <pre><code>-tagger
Utydelig tekstSjekk sidekoding (UTF-8 anbefales)

Håndtering av Integrasjonen

HandlingHvordan
Re-importer altKlikk Import i integrasjonsinnstillingene
Endre nettstedsoversiktOppdater URL og re-importer
Fjern innholdKoble fra integrasjonen eller slett fra Kunnskap
Koble fraInnstillinger → Integrasjoner → Docusaurus → Koble fra

Beste Praksis

  1. Kvalitetsinnhold: Godt skrevne dokumenter = bedre AI-svar
  2. Klar struktur: Bruk overskrifter, lister og tabeller
  3. Beskrivende titler: Sidetitler hjelper AI med å forstå konteksten
  4. Regelmessige oppdateringer: Hold AI oppdatert med den nyeste dokumentasjonen
  5. Test grundig: Still vanlige spørsmål for å verifisere AI-nøyaktighet

Docusaurus Konfigurasjonstips

Optimaliser for AI Utdrag

I din docusaurus.config.js:

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

// Bruk beskrivende sidetitler
title: 'Dokumentasjon for Produktet Ditt',

// Inkluder metadata
themeConfig: {
metadata: [{
name: 'description',
content: 'Dokumentasjon for Produktet Ditt'
}],
},
};

Ekskluder Sider fra Nettstedskart

For å forhindre at visse sider blir synkronisert:

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

Relatert Dokumentasjon

Klar til å heve din
brukeropplevelse?

Distribuer AI-assistenter som gleder kunder og skalerer med virksomheten din.

GDPR-kompatibel