Hopp til hovedinnhold

Docusaurus

Synk Docusaurus-dokumentasjonsnettstedet ditt inn i 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 gjør det mulig for 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 samtalebasert 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 support-chatbot!


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 Innstillinger → Integrasjoner
  3. Finn Docusaurus og klikk Koble til
  4. Skriv inn nettstedskart-URL-en din
  5. Klikk Valider

Trinn 3: Konfigurer Importinnstillinger​

Etter validering, konfigurer importen din:

InnstillingBeskrivelse
Nettstedskart-URLFull URL til 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 crawler hver URL i nettstedskartet ditt
  3. Innholdet blir hentet og lagt til kunnskapsbasen din
  4. Vent til importen er fullført (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 Blir Synkronisert​

InnholdHvordan Det Blir Behandlet
Side tittelBrukt som dokumentidentifikator
SideinnholdFull tekst hentet fra HTML
OverskrifterBevart 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

Synkroniseringsadferd​

Manuell Import​

Klikk Importer i integrasjonsinnstillingene for å:

  • Hente det nyeste nettstedskartet
  • Legge til nye sider
  • Oppdatere endrede sider
  • Fjerne slettede sider

Holde Dokumentene Friske​

For alltid oppdatert dokumentasjon:

  1. Manuell oppdatering: Klikk Import etter publisering av 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​

Bare synkroniser spesifikke seksjoner:

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

Ekskluder Mønstre​

Hopp over bestemte sider:

MønsterEffekt
/docs/internal/*Hopp over interne dokumenter
/changelogHopp over endringsloggsiden
*/draft-*Hopp over utkastssider

Bruksområder​

Teknisk Support 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 merkevare retningslinjene?"

Feilsøking​

Nettstedskartproblemer​

ProblemLøsning
"Ugyldig nettstedskart"Bekreft at URL-en returnerer gyldig XML
"Ingen sider funnet"Sjekk at nettstedskartet inneholder <url>-oppføringer
"Tilgang nektet"Sørg for at nettstedskartet 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 innhenting
Manglende kodeblokkerBekreft at koden er i standard <pre><code>-tags
Utydelig tekstSjekk sidekoding (UTF-8 anbefales)

Administrere Integrasjonen​

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

Beste Praksiser​

  1. Kvalitetsinnhold: Godt skrevne dokumenter = bedre AI-svar
  2. Klar struktur: Bruk overskrifter, lister og tabeller
  3. Beskrivende titler: Side titler hjelper AI med å forstå konteksten
  4. Regelmessige synkroniseringer: 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 Henting​

I din docusaurus.config.js:

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

// Bruk beskrivende sidetitler
title: 'Dine Produktdokumenter',

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

Ekskluder Sider Fra Nettstedskart​

For å forhindre at bestemte 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