Docusaurus
Syncaðu Docusaurus skjalaheimasíðuna þína inn í þekkingargrunn AI SmartTalk. AI þín mun læra af hverju blaði í sitemapi þínu—fullkomið fyrir stuðningsbota sem svara tæknilegum spurningum.
Yfirlit
Docusaurus samþættingin gerir þér kleift að:
- Flytja inn öll blöð úr sitemapi þínu sjálfkrafa
- Halda skjölum samstilltum þegar þú gefur út uppfærslur
- Svara spurningum um skjöl þín á samtalsmáta
- Minnka stuðningsálag með því að láta AI sjá um algengar spurningar
Skemmtileg staðreynd: Skjöl AI SmartTalk nota Docusaurus, og þessi samþætting knýr stuðningschatbot okkar!
Forsendur
Fyrir en þú byrjar, tryggðu að þú hafir:
- Virkt AI SmartTalk reikning
- Docusaurus síðu með gildum
sitemap.xml - Vefsíðan þín verður að vera opinberlega aðgengileg (eða veita auðkenningu)
Skref-fyrir-skref Uppsetning
Skref 1: Finndu Sitemapið Þitt
Docusaurus býr sjálfkrafa til sitemap. Finndu það á:
https://your-docs-site.com/sitemap.xml
Staðfestu að það hlaðist í vafranum þínum og innihaldi skjöl þín.
Skref 2: Bæta við Docusaurus samþættingunni
- Skráðu þig inn á AI SmartTalk reikninginn þinn
- Fara í Stillingar → Samþættingar
- Finndu Docusaurus og smelltu á Tengja
- Sláðu inn URL-ið fyrir sitemapið þitt
- Smelltu á Staðfesta
Skref 3: Stilltu Innflutningsstillingar
Eftir staðfestingu, stilltu innflutninginn þinn:
| Stilling | Lýsing |
|---|---|
| Sitemap URL | Fullt URL fyrir sitemap.xml þitt |
| Innihalda mynstur | Synca aðeins blöð sem passa við mynstur (valfrjálst) |
| Útiloka mynstur | Sleppa ákveðnum blöðum eða svæðum (valfrjálst) |
Skref 4: Byrjaðu Innflutninginn
- Smelltu á Flytja inn blöð
- AI SmartTalk fer í gegnum hvert URL í sitemapi þínu
- Efni er dregið út og bætt við þekkingargrunninn þinn
- Bíddu eftir að innflutningurinn klárist (framvinda sýnd)
Skref 5: Staðfestu Innflutninginn
- Farðu í Þekkingu í AI SmartTalk
- Skjöl þín ættu að birtast
- Prófaðu AI þína með því að spyrja spurninga um skjöl þín
Hvað Er Samstillt
| Efni | Hvernig það er unnið |
|---|---|
| Titill síðu | Notaður sem auðkenni skjals |
| Efni síðu | Heildartexti dreginn úr HTML |
| Fyrirsagnir | Varðveittar fyrir uppbyggingu |
| Kóðablokkar | Innifalin eins og þær eru |
| Töflur | Breytt í læsanlegt form |
| URL | Vefslóð síðu geymd til tilvísunar |
Efnisútdráttur
AI SmartTalk dregur út aðal efnisrýmið og hunsar:
- Vefskipulag
- Hliðarstikur
- Fætur
- Skemmtanir og stíla
Sync hegðun
Handvirk innflutningur
Smelltu á Innflutningur í samþættingarstillingunum til að:
- Sækja nýjasta sitemap
- Bæta við nýjum síðum
- Uppfæra breyttar síður
- Fjarlægja eyddar síður
Halda skjölum ferskum
Til að tryggja að skjölin séu alltaf uppfærð:
- Handvirk endurnýjun: Smelltu á Innflutningur eftir að hafa gefið út uppfærslur
- Skipulögð samstilling: Notaðu SmartFlow til að sjálfvirkniv æða innflutninga
SmartFlow Skipulögð Innflutningur
Workflow: Docusaurus Auto-Sync
Trigger: Scheduled (Daily at 3:00 AM)
Actions:
- Sync Connector:
Type: Docusaurus
Sitemap: https://docs.example.com/sitemap.xml
URL mynstur
Innifela mynstur
Samstilltu aðeins ákveðnar deildir:
| Mynstur | Áhrif |
|---|---|
/docs/api/* | Aðeins API skjöl |
/docs/guides/* | Aðeins leiðbeiningar deild |
/blog/* | Aðeins bloggfærslur |
Útiloka mynstur
Sleppa ákveðnum síðum:
| Mynstur | Áhrif |
|---|---|
/docs/internal/* | Sleppa innri skjölum |
/changelog | Sleppa breytingaskrá síðu |
*/draft-* | Sleppa drögum síðum |
Notkunartilvik
Tæknilegur stuðningsbotn
Samstilltu skjöl um vöruna þína:
- "Hvernig set ég SDK-ið upp?"
- "Hverjir eru API hraðamörkin?"
- "Sýndu mér dæmi um auðkenningu"
Þróunarskjöl
Samstilltu API tilvísanir og leiðbeiningar:
- "Hvaða breytur samþykkir /users endapunkturinn?"
- "Hvernig meðhöndla ég vefkalla?"
- "Hver er munurinn á v1 og v2 API?"
Innri þekkingargrunnur
Samstilltu fyrirtækjaskrár og aðferðir:
- "Hver er ferlið við að biðja um PTO?"
- "Hvernig stilli ég þróunaraðstöðu mína?"
- "Hvar finn ég leiðbeiningar um vörumerki?"
Vandamálalausn
Sitemap vandamál
| Vandamál | Lausn |
|---|---|
| "Ógilt sitemap" | Staðfestu að URL skili gildum XML |
| "Engar síður fundust" | Athugaðu að sitemap innihaldi <url> færslur |
| "Aðgangur hafnað" | Tryggðu að sitemap sé opinberlega aðgengilegt |
Innflutningsvandamál
| Vandamál | Lausn |
|---|---|
| Síður vantar | Athugaðu innifela/útiloka mynstur |
| Innflutningur fastur | Stórar síður taka tíma; bíða eða innflytja í lotum |
| Gamall innihald | Endurinnflytja til að sækja nýjustu útgáfur |
Gæði efnis
| Vandamál | Lausn |
|---|---|
| Rangt efni slegið út | Tjáðu vandamálið—gæti þurft sérsniðið útdrátt |
| Vantar kóðablokkir | Staðfestu að kóðinn sé í staðlaðum <pre><code> merkjum |
| Ruglað texti | Athugaðu kóðun síðu (UTF-8 mælt með) |
Stjórnun samþættingarinnar
| Aðgerð | Hvernig |
|---|---|
| Endurinnflytja allt | Smelltu á Innflutningur í samþættingarstillingunum |
| Breyta sitemap | Uppfærðu URL og endurinnflytja |
| Fjarlægja efni | Aftengja samþættingu eða eyða úr þekkingu |
| Aftengja | Stillingar → Samþættingar → Docusaurus → Aftengja |
Best Practices
- Gæðainnihald: Vel skrifuð skjöl = betri svör frá AI
- Skýr uppbygging: Notaðu fyrirsagnir, lista og töflur
- Lýsandi titlar: Titlar á síðum hjálpa AI að skilja samhengi
- Regluleg samstilling: Haltu AI uppfærðu með nýjustu skjölunum
- Prófaðu vandlega: Spurðu algengar spurningar til að staðfesta nákvæmni AI
Docusaurus Configuration Tips
Optimize for AI Extraction
In your docusaurus.config.js:
module.exports = {
// Ensure sitemap is generated
plugins: ['@docusaurus/plugin-sitemap'],
// Use descriptive page titles
title: 'Your Product Docs',
// Include metadata
themeConfig: {
metadata: [{
name: 'description',
content: 'Documentation for Your Product'
}],
},
};
Exclude Pages from Sitemap
To prevent certain pages from being synced:
// In page frontmatter
---
title: Internal Page
sitemap:
exclude: true
---
Related Documentation
- Integrations Overview
- Knowledge Base Management
- RSS Feed Integration — Fyrir blogg/frettainnihald
- SmartFlow Scheduled Triggers — Sjálfvirk innflutningur