Docusaurus

Synkronoi Docusaurus-dokumentaatiosivustosi AI SmartTalkin tietopankkiin. AI oppii jokaiselta sivulta sivustokartassasi—täydellinen tukiboteille, jotka vastaavat teknisiin kysymyksiin.

---

Yhteenveto

Docusaurus-integraatio mahdollistaa sinulle:

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

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

---

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 täältä:

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

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

Vaihe 2: Lisää Docusaurus-integraatio

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

Vaihe 3: Määritä tuontiasetukset

Vahvistuksen jälkeen määritä tuontisi:

Asetus	Kuvaus
Sivustokartan URL	Kokonais-URL sivustokarttaasi
Sisällytä mallit	Synkronoi vain sivut, jotka vastaavat malleja (valinnainen)
Poista mallit	Ohita tietyt sivut tai osiot (valinnainen)

Vaihe 4: Aloita tuonti

1. Napsauta Tuo sivut
2. AI SmartTalk käy läpi jokaisen URL:n sivustokartassasi
3. Sisältö kerätään ja lisätään tietopankkiisi
4. Odota, että tuonti valmistuu (edistyminen näkyy)

Vaihe 5: Vahvista tuonti

1. Siirry kohtaan Tieto AI SmartTalkissa
2. Dokumentaatiosivujesi pitäisi 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	Sisällytetään sellaisenaan
Taulukot	Muutetaan luettavaksi muodoksi
URL-osoitteet	Sivun URL tallennetaan viitteeksi

Sisällön keruu

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

• Navigointivalikot
• Sivupalkit
• Alatunnisteet
• Skriptit ja tyylit

---

Synkronointikäyttäytyminen

Manuaalinen tuonti

Napsauta Tuo integraatioasetuksissa:

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

Dokumenttien pitäminen ajantasaisina

Jotta dokumentaatio olisi aina ajankohtaista:

1. Manuaalinen päivitys: Napsauta Tuo päivitysten julkaisemisen jälkeen
2. Aikataulutettu synkronointi: Käytä SmartFlow'ta automatisoidaksesi tuonnit

SmartFlow Aikataulutettu Tuo

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ällytä mallit

Synkronoi vain tietyt osiot:

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

Poista mallit

Ohita tietyt sivut:

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

---

Käyttötapaukset

Tekninen tukibotti

Synkronoi tuotedokumentaatiosi:

• "Kuinka asennan SDK:n?"
• "Mitkä ovat API:n nopeusrajoitukset?"
• "Näytä minulle esimerkki todennuksesta"

Kehittäjädokumentaatio

Synkronoi API-viitteet ja oppaat:

• "Mitä parametreja /users-päätepiste hyväksyy?"
• "Kuinka 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?"
• "Kuinka 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öytynyt"	Tarkista, että sivustokartta sisältää <url>-merkinnät
"Pääsy kielletty"	Varmista, että sivustokartta on julkisesti saatavilla

Tuontiongelmat

Ongelma	Ratkaisu
Sivut puuttuvat	Tarkista sisällytä/poista mallit
Tuo 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ö kerätty	Ilmoita ongelmasta—voi tarvita mukautettua keruuta
Puuttuvat koodilohkot	Varmista, että koodi on standardeissa <pre><code>-tageissa
Sekava teksti	Tarkista sivun koodaus (UTF-8 suositeltava)

---

Integraation hallinta

Toiminto	Kuinka
Tuo kaikki uudelleen	Napsauta Tuo integraatioasetuksissa
Vaihda sivustokartta	Päivitä URL ja tuo uudelleen
Poista sisältö	Katkaise integraatio tai poista Tieto-osasta
Katkaise yhteys	Asetukset → Integraatiot → Docusaurus → Katkaise yhteys

---

Parhaat käytännöt

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

---

Docusaurus-asetusten vinkit

Optimoi AI:n keruuta varten

Tiedostossasi docusaurus.config.js:

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

Poista sivuja 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