Docusaurus

Synkronoi Docusaurus-dokumentaatiosivustosi AI SmartTalkin tietopohjaan. AI oppii jokaiselta sivulta sivustokartassasi—erinomainen tuki boteille, jotka vastaavat teknisiin kysymyksiin.

---

Yhteenveto

Docusaurus-integraatio mahdollistaa sinulle:

• Tuoda kaikki sivut sivustokartastasi automaattisesti
• Pitää dokumentit synkronoituna julkaistessasi päivityksiä
• Vastaamaan kysymyksiin dokumentaatiostasi keskustellen
• Vähentämään tukikuormitusta antamalla AI:n käsitellä yleisiä kysymyksiä

Hauska fakta: AI SmartTalkin oma dokumentaatio käyttää Docusaurusta, ja tämä integraatio tukee tuki-chatbottiamme!

---

Esivaatimukset

Ennen kuin aloitat, varmista, että sinulla on:

• Aktiivinen AI SmartTalk -tili
• Docusaurus-sivusto, jossa on voimassa oleva sitemap.xml
• Sivustosi on oltava julkisesti saatavilla (tai tarjoa todennus)

---

Vaiheittainen asennus

Vaihe 1: Etsi sivustokarttasi

Docusaurus luo automaattisesti sivustokartan. Löydät sen osoitteesta:

https://your-docs-site.com/sitemap.xml

Varmista, että se latautuu selaimessasi ja sisältää dokumentaatiosivusi.

Vaihe 2: Lisää Docusaurus-integraatio

1. Kirjaudu AI SmartTalk -tilillesi
2. Siirry kohtaan Asetukset → Integraatiot
3. Etsi Docusaurus ja napsauta Yhdistä
4. Syötä sivustokartan URL-osoite
5. Napsauta Vahvista

Vaihe 3: Määritä tuontiasetukset

Vahvistuksen jälkeen määritä tuontisi:

Asetus	Kuvaus
Sivustokartan URL	Kokonaisosoite sitemap.xml-tiedostollesi
Sisällyttämismallit	Synkronoi vain mallit, jotka vastaavat malleja (valinnainen)
Poissulkemismallit	Ohita tietyt sivut tai osiot (valinnainen)

Vaihe 4: Aloita tuonti

1. Napsauta Tuo sivut
2. AI SmartTalk käy läpi jokaisen URL-osoitteen sivustokartassasi
3. Sisältö kerätään ja lisätään tietopohjaasi
4. Odota, että tuonti valmistuu (edistymistä näytetään)

Vaihe 5: Vahvista tuonti

1. Siirry kohtaan Tieto AI SmartTalkissa
2. Dokumentaatiosivujesi tulisi näkyä
3. Testaa AI:ta kysymällä kysymyksiä dokumenteistasi

---

Mitä synkronoidaan

Sisältö	Kuinka se käsitellään
Sivun otsikko	Käytetään asiakirjan tunnisteena
Sivun sisältö	Täysi teksti kerätään HTML:stä
Otsikot	Säilytetään rakenteen vuoksi
Koodilohkot	Lisätään sellaisenaan
Taulukot	Muutetaan luettavaksi muodoksi
URL-osoitteet	Sivun URL tallennetaan viitteeksi

Sisällön kerääminen

AI SmartTalk kerää pääsisältöalueen ja ohittaa:

• Navigointivalikot
• Sivupalkit
• Alatunnisteet
• Skriptit ja tyylit

---

Synkronointikäyttäytyminen

Manuaalinen tuonti

Napsauta Tuonti integraatioasetuksissa:

• Hae uusin sivustokartta
• Lisää uusia sivuja
• Päivitä muuttuneet sivut
• Poista poistuneet sivut

Asiakirjojen Ajantasaisuus

Jatkuvasti ajantasaisen dokumentaation varmistamiseksi:

1. Manuaalinen päivitys: Napsauta Tuonti päivitysten julkaisemisen jälkeen
2. Aikataulutettu synkronointi: Käytä SmartFlow'ta tuontien automatisoimiseen

SmartFlow Aikataulutettu Tuonti

Workflow: Docusaurus Auto-Sync
Trigger: Scheduled (Daily at 3:00 AM)
Actions:
  - Sync Connector:
      Type: Docusaurus
      Sitemap: https://docs.example.com/sitemap.xml

---

URL-mallit

Sisällyttämismallit

Synkronoi vain tietyt osiot:

Malli	Vaikutus
/docs/api/*	Vain API-dokumentaatio
/docs/guides/*	Vain oppaat-osio
/blog/*	Vain blogikirjoitukset

Poissulkemismallit

Ohita tietyt sivut:

Malli	Vaikutus
/docs/internal/*	Ohita sisäiset asiakirjat
/changelog	Ohita muutossivun
*/draft-*	Ohita luonnossivut

---

Käyttötapaukset

Tekninen Tuki -botti

Synkronoi tuotedokumentaatiosi:

• "Miten asennan SDK:n?"
• "Mitkä ovat API:n käyttörajoitukset?"
• "Näytä esimerkki todennuksesta"

Kehittäjädokumentaatio

Synkronoi API-viitteet ja oppaat:

• "Mitä parametreja /users päätepiste hyväksyy?"
• "Miten käsittelen webhookkeja?"
• "Mikä on ero v1 ja v2 API:n välillä?"

Sisäinen Tietopankki

Synkronoi yrityksen wikit ja menettelyt:

• "Mikä on prosessi PTO:n pyytämiseksi?"
• "Miten asetetaan kehitysympäristöni?"
• "Mistä löydän brändiohjeet?"

---

Vianetsintä

Sivustokarttaongelmat

Ongelma	Ratkaisu
"Virheellinen sivustokartta"	Varmista, että URL palauttaa voimassa olevan XML:n
"Sivuja ei löydy"	Tarkista, että sivustokartta sisältää <url>-merkinnät
"Pääsy kielletty"	Varmista, että sivustokartta on julkisesti saatavilla

Tuontiongelmat

Ongelma	Ratkaisu
Sivut puuttuvat	Tarkista sisällyttämis-/poissulkemismallit
Tuonti jumissa	Suuret sivustot vievät aikaa; odota tai tuo erissä
Vanha sisältö	Tuo uudelleen saadaksesi uusimmat versiot

Sisällön Laatu

Ongelma	Ratkaisu
Väärä sisältö poimittu	Ilmoita ongelmasta—voi tarvita mukautettua poimintaa
Puuttuvat koodilohkot	Varmista, että koodi on standardin <pre><code>-tageissa
Sekava teksti	Tarkista sivun koodaus (UTF-8 suositeltava)

---

Integraation Hallinta

Toiminto	Kuinka
Tuo kaikki uudelleen	Napsauta Tuonti integraatioasetuksissa
Vaihda sivustokartta	Päivitä URL ja tuo uudelleen
Poista sisältö	Irrota integraatio tai poista Tietopankista
Irrota	Asetukset → Integraatiot → Docusaurus → Irrota

---

Parhaat käytännöt

1. Laadukas sisältö: Hyvin kirjoitetut asiakirjat = paremmat AI-vastaukset
2. Selkeä rakenne: Käytä otsikoita, luetteloita ja taulukoita
3. Kuvailevat otsikot: Sivun otsikot auttavat AI:ta ymmärtämään kontekstia
4. Säännölliset synkronoinnit: Pidä AI ajan tasalla viimeisimmän dokumentaation kanssa
5. Testaa perusteellisesti: Kysy yleisiä kysymyksiä varmistaaksesi AI:n tarkkuuden

---

Docusaurus-konfiguraatiovinkit

Optimoi AI:n tietojen poimimista varten

Tiedostossasi docusaurus.config.js:

module.exports = {
  // Varmista, että sivustokartta luodaan
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Käytä kuvailevia sivun otsikoita
  title: 'Tuotteesi asiakirjat',
  
  // Sisällytä metatietoja
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentaatio tuotteellesi'
    }],
  },
};

Poista sivut sivustokartasta

Estääksesi tiettyjen sivujen synkronoinnin:

// Sivun frontmatterissa
---
title: Sisäinen sivu
sitemap:
  exclude: true
---

---

Liittyvä dokumentaatio

• Integraatioiden yleiskatsaus
• Tietopankin hallinta
• RSS-syötteen integraatio — Blogi/uutissisältöä varten
• SmartFlow-aikataulutetut laukaisimet — Automatisoi tuonnit