Docusaurus
Synkroniser Docusaurus-dokumentasjonsnettstedet ditt 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 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 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 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
- Logg inn på AI SmartTalk-kontoen din
- Naviger til Innstillinger → Integrasjoner
- Finn Docusaurus og klikk Koble til
- Skriv inn URL-en til nettstedskartet ditt
- Klikk Valider
Trinn 3: Konfigurer Importinnstillinger
Etter validering, konfigurer importen din:
| Innstilling | Beskrivelse |
|---|---|
| Nettstedskart URL | Full URL til ditt sitemap.xml |
| Inkluder mønstre | Bare synkroniser sider som matcher mønstre (valgfritt) |
| Ekskluder mønstre | Hopp over spesifikke sider eller seksjoner (valgfritt) |
Trinn 4: Start Importen
- Klikk Importer Sider
- AI SmartTalk gjennomgår hver URL i nettstedskartet ditt
- Innholdet blir ekstrahert og lagt til kunnskapsbasen din
- Vent på at importen skal fullføres (fremdrift vises)
Trinn 5: Bekreft Importen
- Gå til Kunnskap i AI SmartTalk
- Dokumentasjonssidene dine skal vises
- Test AI-en din ved å stille spørsmål om dokumentene dine
Hva Blir Synkronisert
| Innhold | Hvordan Det Behandles |
|---|---|
| Side tittel | Brukes som dokumentidentifikator |
| Sideinnhold | Full tekst ekstrahert fra HTML |
| Overskrifter | Bevart for struktur |
| Kodeblokker | Inkludert som de er |
| Tabeller | Konvertert til lesbart format |
| URL-er | Side-URL lagret for referanse |
Innholdsekstraksjon
AI SmartTalk ekstraherer hovedinnholdsområdet og ignorerer:
- Navigasjonsmenyer
- Sidefelt
- Bunntekster
- Skript og stiler
Synkroniseringsatferd
Manuell import
Klikk Import i integrasjonsinnstillingene for å:
- Hente den nyeste sitemap
- Legge til nye sider
- Oppdatere endrede sider
- Fjerne slettede sider
Holde dokumenter oppdaterte
For alltid oppdatert dokumentasjon:
- Manuell oppdatering: Klikk Import etter publisering av oppdateringer
- 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ønster | Effekt |
|---|---|
/docs/api/* | Bare API-dokumentasjon |
/docs/guides/* | Bare veiledningsseksjonen |
/blog/* | Bare blogginnlegg |
Ekskluder mønstre
Hopp over bestemte sider:
| Mønster | Effekt |
|---|---|
/docs/internal/* | Hopp over interne dokumenter |
/changelog | Hopp over endringslogg-siden |
*/draft-* | Hopp over utkast-sider |
Bruksområder
Teknisk supportbot
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
Sitemap-problemer
| Problem | Løsning |
|---|---|
| "Ugyldig sitemap" | Bekreft at URL-en returnerer gyldig XML |
| "Ingen sider funnet" | Sjekk at sitemap inneholder <url>-oppføringer |
| "Tilgang nektet" | Sørg for at sitemap er offentlig tilgjengelig |
Importproblemer
| Problem | Løsning |
|---|---|
| Sider mangler | Sjekk inkluder/ekskluder mønstre |
| Import fast | Store nettsteder tar tid; vent eller importer i batcher |
| Gammelt innhold | Re-importer for å hente de nyeste versjonene |
Innholdskvalitet
| Problem | Løsning |
|---|---|
| Feil innhold hentet | Rapportér problemet—kan trenge tilpasset ekstraksjon |
| Manglende kodeblokker | Bekreft at koden er i standard <pre><code>-tagger |
| Utydelig tekst | Sjekk sidekoding (UTF-8 anbefales) |
Administrere integrasjonen
| Handling | Hvordan |
|---|---|
| Re-importer alt | Klikk Import i integrasjonsinnstillingene |
| Endre sitemap | Oppdater URL og re-importer |
| Fjern innhold | Koble fra integrasjonen eller slett fra Kunnskap |
| Koble fra | Innstillinger → Integrasjoner → Docusaurus → Koble fra |
Beste praksis
- Kvalitetsinnhold: Godt skrevne dokumenter = bedre AI-svar
- Klar struktur: Bruk overskrifter, lister og tabeller
- Beskrivende titler: Side titler hjelper AI med å forstå konteksten
- Regelmessige oppdateringer: Hold AI oppdatert med den nyeste dokumentasjonen
- Test grundig: Still vanlige spørsmål for å verifisere AI-nøyaktighet
Docusaurus konfigurasjonstips
Optimaliser for AI-uttrekk
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 visse sider blir synkronisert:
// I side frontmatter
---
title: Intern side
sitemap:
exclude: true
---
Relatert dokumentasjon
- Integrasjoner Oversikt
- Kunnskapsbase Administrasjon
- RSS Feed Integrasjon — For blogg/nyhetsinnhold
- SmartFlow Planlagte Utløsere — Automatiser importerer