Docusaurus

Sinċronizza s-sit ta' dokumentazzjoni Docusaurus tiegħek mal-bażi ta' tagħrif ta' AI SmartTalk. L-AI tiegħek se titgħallem minn kull paġna fil-mappa tas-sit tiegħek—ideali għall-bots ta' appoġġ li jwieġbu mistoqsijiet tekniċi.

---

Oversight

L-integrazzjoni Docusaurus tippermettilek li:

• Importa l-paġni kollha mill-mappa tas-sit tiegħek awtomatikament
• Żomm id-dokumenti sinċronizzati meta pubbliki aggiornamenti
• Iwieġeb mistoqsijiet dwar id-dokumentazzjoni tiegħek b'mod konversazzjonali
• Irriduci l-għan ta' appoġġ billi tagħti l-AI biex timmaniġġja mistoqsijiet komuni

Fatt divertenti: Id-dokumentazzjoni ta' AI SmartTalk stess tuża Docusaurus, u din l-integrazzjoni tħaddem il-chatbot ta' appoġġ tagħna!

---

Prerequisites

Qabel ma tibda, żgura li għandek:

• Kont attiv ta' AI SmartTalk
• Sit Docusaurus b'sitemap.xml validu
• Is-sit tiegħek għandu jkun aċċessibbli pubblikament (jew ipprovdi awtentikazzjoni)

---

Pass Pass għall-Istabbiliment

Pass 1: Sib il-Mappa tas-Sit Tiegħek

Docusaurus awtomatikament joħloq mappa tas-sit. Sibha f':

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

Iċċekkja li tgħaqqad fil-browser tiegħek u li fiha l-paġni tad-dokumentazzjoni tiegħek.

Pass 2: Żid l-Integrazzjoni Docusaurus

1. Log in fil-kont tiegħek ta' AI SmartTalk
2. Naviga lejn Settings → Integrations
3. Sib Docusaurus u ikklikkja Connect
4. Daħħal l-URL tal-mappa tas-sit tiegħek
5. Ikklikkja Validate

Pass 3: Ipprova l-Settings tal-Importazzjoni

Wara l-validazzjoni, ipprova l-importazzjoni tiegħek:

Setting	Deskrizzjoni
Sitemap URL	URL sħiħ għall-mappa tas-sit tiegħek sitemap.xml
Inkludi patterns	Sinċronizza biss il-paġni li jaqblu mal-pattini (opzjonali)
Eskludi patterns	Iskipja paġni jew sezzjonijiet speċifiċi (opzjonali)

Pass 4: Ibda l-Importazzjoni

1. Ikklikkja Import Pages
2. AI SmartTalk tgħaqqad kull URL fil-mappa tas-sit tiegħek
3. Il-kontenut jiġi estratt u miżjud mal-bażi ta' tagħrif tiegħek
4. Stenna li l-importazzjoni tkun kompluta (proċess muri)

Pass 5: Iċċekkja l-Importazzjoni

1. Mur lejn Knowledge f'AI SmartTalk
2. Il-paġni tad-dokumentazzjoni tiegħek għandhom jidhru
3. Ittestja l-AI tiegħek billi tistaqsi mistoqsijiet dwar id-dokumenti tiegħek

---

X'Jinsab Sinċronizzat

Kontenut	Kif Huwa Pproċessat
Titolu tal-paġna	Użat bħala identifikatur tad-dokument
Kontenut tal-paġna	Test sħiħ estratt mill-HTML
Titoli	Mantenuti għall-struttura
Blokki ta' kodifikazzjoni	Inkludi kif huma
Tabelli	Mkonvertiti f'format li jista' jiġi qrat
URLs	URL tal-paġna maħżun għal referenza

Estrazzjoni tal-Kontenut

AI SmartTalk estratti l-oqsma prinċipali tal-kontenut u jinjora:

• Menu ta' navigazzjoni
• Barriera ta' naħa
• Footer
• Skripts u stili

---

Imġieba ta' Sync

Importazzjoni Manwali

Ikklikkja Import fil-settings tal-integrazzjoni biex:

• Tiġbor is-sitemap l-aktar reċenti
• Żżid paġni ġodda
• Aġġorna paġni mibdula
• Tneħħi paġni mħassra

Żżomm id-Dokumenti Aġġornati

Għal dokumentazzjoni dejjem attwali:

1. Rinfresk manwali: Ikklikkja Import wara li pubblika aġġornamenti
2. Sync skedat: Uża SmartFlow biex tautomatizza l-importazzjonijiet

Importazzjoni Skedata SmartFlow

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

---

Patterns tal-URL

Patterns Inkluż

Biss sync sekzjonijiet speċifiċi:

Pattern	Effett
/docs/api/*	Biss dokumentazzjoni tal-API
/docs/guides/*	Biss sekzzjoni tal-gwidi
/blog/*	Biss posts tal-blog

Patterns Esklużi

Skippa ċerti paġni:

Pattern	Effett
/docs/internal/*	Skippa d-dokumenti interni
/changelog	Skippa l-paġna tal-changelog
*/draft-*	Skippa paġni draft

---

Każijiet ta' Użu

Bot ta' Appoġġ Tekniku

Sync id-dokumentazzjoni tal-prodott tiegħek:

• "Kif nista' ninstallaw l-SDK?"
• "X'inhuma l-limiti tal-API?"
• "Uri lili eżempju ta' awtentikazzjoni"

Dokumentazzjoni tal-Iżviluppatur

Sync referenzi tal-API u gwidi:

• "X'parametri aċċetta l-endpoint /users?"
• "Kif nista' nħaddem webhooks?"
• "X'hemm differenza bejn v1 u v2 tal-API?"

Bażi ta' Għarfien Interna

Sync wikis u proċeduri tal-kumpanija:

• "X'inhu l-proċess biex titlob PTO?"
• "Kif nista' nissettja l-ambjent tal-iżvilupp tiegħi?"
• "Fejn nista' nsib il-linji gwida tal-marka?"

---

Troubleshooting

Problemi mas-Sitemap

Problema	Soluzzjoni
"Sitemap mhux valida"	Verifika li l-URL jirritorna XML validu
"L-ebda paġni ma nstabu"	Iċċekkja li s-sitemap fiha entrati <url>
"Aċċess miċħud"	Żgura li s-sitemap hija aċċessibbli pubblikament

Problemi ta' Importazzjoni

Problema	Soluzzjoni
Paġni nieqsa	Iċċekkja l-patterns inklużi/esklużi
Importazzjoni ma tħallix	Sitijiet kbar jieħdu żmien; stenna jew import f'partijiet
Kontenut qadim	Re-importa biex tiġbor l-aħħar verżjonijiet

Kwalità tal-Kontenut

Problema	Soluzzjoni
Kontenut żbaljat estratt	Rapporta l-problema—jista' jkun li jeħtieġ estrazzjoni personalizzata
Blokki ta' kodiċi nieqsa	Verifika li l-kodiċi jinsab f'taġit <pre><code> standard
Test għaġin	Iċċekkja l-encoding tal-paġna (UTF-8 rakkomandat)

---

Ġestjoni tal-Integrazzjoni

Azjoni	Kif
Re-importa kollox	Ikklikkja Import fil-settings tal-integrazzjoni
Biddel is-sitemap	Aġġorna l-URL u re-importa
Neħħi kontenut	Dgħajfa l-integrazzjoni jew iħassar mill-Għarfien
Dgħajfa	Settings → Integrations → Docusaurus → Dgħajfa

---

Prattiċi Aħjar

1. Kontenut ta' kwalità: Dokumenti miktuba tajjeb = risposti aħjar mill-AI
2. Struttura ċara: Uża titli, listi, u tabelli
3. Titli deskrittivi: Titli tal-paġni jgħinu l-AI biex tifhem il-kuntest
4. Syncs regolari: Żomm l-AI aġġornat bil-dokumentazzjoni l-aktar reċenti
5. Testa b'mod sħiħ: Staqsi mistoqsijiet komuni biex tiċċekkja l-eżattezza tal-AI

---

Suggerimenti għall-Konfigurazzjoni ta' Docusaurus

Ottimizza għall-Estrazzjoni tal-AI

Fil-fajl tiegħek docusaurus.config.js:

module.exports = {
  // Żgura li s-sitemap tiġi ġenerata
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Uża titli tal-paġni deskrittivi
  title: 'Your Product Docs',
  
  // Inkludi metadata
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Documentation for Your Product'
    }],
  },
};

Eskludi Paġni mis-Sitemap

Biex tevita li ċerti paġni jiġu syncjati:

// Fil-frontmatter tal-paġna
---
title: Internal Page
sitemap:
  exclude: true
---

---

Dokumentazzjoni Relatata

• Integrations Overview
• Knowledge Base Management
• RSS Feed Integration — Għal kontenut tal-blog/aħbarijiet
• SmartFlow Scheduled Triggers — Awtomatizza l-importazzjonijiet