Hoppa yfir á aðal efni

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

  1. Skráðu þig inn á AI SmartTalk reikninginn þinn
  2. Fara í StillingarSamþættingar
  3. Finndu Docusaurus og smelltu á Tengja
  4. Sláðu inn URL-ið fyrir sitemapið þitt
  5. Smelltu á Staðfesta

Skref 3: Stilltu Innflutningsstillingar

Eftir staðfestingu, stilltu innflutninginn þinn:

StillingLýsing
Sitemap URLFullt URL fyrir sitemap.xml þitt
Innihalda mynsturSynca aðeins blöð sem passa við mynstur (valfrjálst)
Útiloka mynsturSleppa ákveðnum blöðum eða svæðum (valfrjálst)

Skref 4: Byrjaðu Innflutninginn

  1. Smelltu á Flytja inn blöð
  2. AI SmartTalk fer í gegnum hvert URL í sitemapi þínu
  3. Efni er dregið út og bætt við þekkingargrunninn þinn
  4. Bíddu eftir að innflutningurinn klárist (framvinda sýnd)

Skref 5: Staðfestu Innflutninginn

  1. Farðu í Þekkingu í AI SmartTalk
  2. Skjöl þín ættu að birtast
  3. Prófaðu AI þína með því að spyrja spurninga um skjöl þín

Hvað Er Samstillt

EfniHvernig það er unnið
Titill síðuNotaður sem auðkenni skjals
Efni síðuHeildartexti dreginn úr HTML
FyrirsagnirVarðveittar fyrir uppbyggingu
KóðablokkarInnifalin eins og þær eru
TöflurBreytt í læsanlegt form
URLVefslóð 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ð:

  1. Handvirk endurnýjun: Smelltu á Innflutningur eftir að hafa gefið út uppfærslur
  2. 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
/changelogSleppa 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álLausn
"Ó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álLausn
Síður vantarAthugaðu innifela/útiloka mynstur
Innflutningur fasturStórar síður taka tíma; bíða eða innflytja í lotum
Gamall innihaldEndurinnflytja til að sækja nýjustu útgáfur

Gæði efnis

VandamálLausn
Rangt efni slegið útTjáðu vandamálið—gæti þurft sérsniðið útdrátt
Vantar kóðablokkirStaðfestu að kóðinn sé í staðlaðum <pre><code> merkjum
Ruglað textiAthugaðu kóðun síðu (UTF-8 mælt með)

Stjórnun samþættingarinnar

AðgerðHvernig
Endurinnflytja alltSmelltu á Innflutningur í samþættingarstillingunum
Breyta sitemapUppfærðu URL og endurinnflytja
Fjarlægja efniAftengja samþættingu eða eyða úr þekkingu
AftengjaStillingar → Samþættingar → Docusaurus → Aftengja

Best Practices

  1. Gæðainnihald: Vel skrifuð skjöl = betri svör frá AI
  2. Skýr uppbygging: Notaðu fyrirsagnir, lista og töflur
  3. Lýsandi titlar: Titlar á síðum hjálpa AI að skilja samhengi
  4. Regluleg samstilling: Haltu AI uppfærðu með nýjustu skjölunum
  5. 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
---

Klárt að hækka þína
notendaupplifun?

Settu upp AI aðstoðarmenn sem gleðja viðskiptavini og stækka með fyrirtækinu þínu.

GDPR samhæft