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 konversatorisk
- Reducerer 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
- Log ind på din AI SmartTalk konto
- Naviger til Indstillinger → Integrationer
- Find Docusaurus og klik på Forbind
- Indtast din sitemap URL
- Klik på Valider
Trin 3: Konfigurer Importindstillinger
Efter validering, konfigurer din import:
| Indstilling | Beskrivelse |
|---|---|
| Sitemap URL | Fuld URL til dit sitemap.xml |
| Inkluder mønstre | Synk kun sider, der matcher mønstre (valgfrit) |
| Ekskluder mønstre | Spring specifikke sider eller sektioner over (valgfrit) |
Trin 4: Start Importen
- Klik på Importer Sider
- AI SmartTalk crawler hver URL i dit sitemap
- Indholdet udtrækkes og tilføjes til din vidensbase
- Vent på, at importen er færdig (fremskridt vises)
Trin 5: Bekræft Importen
- Gå til Viden i AI SmartTalk
- Dine dokumentationssider skal vises
- Test din AI ved at stille spørgsmål om dine dokumenter
Hvad bliver synkroniseret
| Indhold | Hvordan det behandles |
|---|---|
| Side titel | Bruges som dokumentidentifikator |
| Side indhold | Fuld tekst udtrukket fra HTML |
| Overskrifter | Bevares for struktur |
| Kodeblokke | Inkluderes som de er |
| Tabeller | Konverteres til læsbart format |
| URLs | Side URL gemmes til reference |
Indholdsudtrækning
AI SmartTalk udtrækker hovedindholdsområdet og ignorerer:
- Navigationsmenuer
- Sidepaneler
- Fodnoter
- Scripts og stilarter
Synkroniseringsadfærd
Manuel import
Klik på Import i integrationsindstillingerne for at:
- Hente den nyeste sitemap
- Tilføje nye sider
- Opdatere ændrede sider
- Fjerne slettede sider
Holde dokumentationen opdateret
For altid aktuel dokumentation:
- Manuel opdatering: Klik på Import efter offentliggørelse af opdateringer
- 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ønster | Effekt |
|---|---|
/docs/api/* | Kun API-dokumentation |
/docs/guides/* | Kun guide-sektionen |
/blog/* | Kun blogindlæg |
Ekskluder mønstre
Spring bestemte sider over:
| Mønster | Effekt |
|---|---|
/docs/internal/* | Spring interne dokumenter over |
/changelog | Spring changelog-siden over |
*/draft-* | Spring udkastssider over |
Anvendelsessager
Teknisk supportbot
Synkroniser din produktdokumentation:
- "Hvordan installerer jeg SDK'en?"
- "Hvad er API'ets hastighedsbegrænsninger?"
- "Vis mig et eksempel på autentificering"
Udviklerdokumentation
Synkroniser API-referencer og guider:
- "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
| Problem | Løsning |
|---|---|
| "Ugyldig 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ængelig |
Importproblemer
| Problem | Løsning |
|---|---|
| Sider mangler | Tjek inkluder/ekskluder mønstre |
| Import sidder fast | Store sider tager tid; vent eller importer i batches |
| Gammelt indhold | Re-importer for at hente de nyeste versioner |
Indholdskvalitet
| Problem | Løsning |
|---|---|
| Forkert indhold udtrukket | Rapportér problemet—kan kræve tilpasset udtrækning |
| Manglende kodeblokke | Bekræft, at koden er i standard <pre><code> tags |
| Utydelig tekst | Tjek sidekodning (UTF-8 anbefales) |
Håndtering af integrationen
| Handling | Hvordan |
|---|---|
| Re-importer alt | Klik på Import i integrationsindstillingerne |
| Ændre sitemap | Opdater URL og re-importer |
| Fjern indhold | Afbryd integrationen eller slet fra Knowledge |
| Afbryd | Indstillinger → Integrationer → Docusaurus → Afbryd |
Bedste Praksis
- Kvalitetsindhold: Veludførte dokumenter = bedre AI-svar
- Klar struktur: Brug overskrifter, lister og tabeller
- Beskrivende titler: Side titler hjælper AI med at forstå konteksten
- Regelmæssige synkroniseringer: Hold AI opdateret med den nyeste dokumentation
- Test grundigt: Stil almindelige spørgsmål for at verificere 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: 'Dine Produktdokumenter',
// Inkluder metadata
themeConfig: {
metadata: [{
name: 'description',
content: 'Dokumentation for Dit Produkt'
}],
},
};
Udelukke Sider fra Sitemap
For at forhindre visse sider i at blive synkroniseret:
// I side frontmatter
---
title: Intern Side
sitemap:
exclude: true
---
Relateret Dokumentation
- Integrationsoversigt
- Vidensbase Administration
- RSS Feed Integration — Til blog-/nyhedsindhold
- SmartFlow Planlagte Udløsere — Automatiser importer