Docusaurus

Синхронизирајте ја вашата Docusaurus документација во базата на знаење на AI SmartTalk. Вашиот AI ќе учи од секоја страница во вашиот мапа на страниците—совршено за поддршка на ботови кои одговараат на технички прашања.

---

Преглед

Интеграцијата на Docusaurus ви овозможува да:

• Импортрате сите страници од вашата мапа на страниците автоматски
• Држите документација синхронизирана кога објавувате ажурирања
• Одговарате на прашања за вашата документација разговорно
• Намалите оптоварување на поддршката дозволувајќи на AI да се справи со вообичаени прашања

Забавен факт: Документацијата на AI SmartTalk користи Docusaurus, а оваа интеграција ја поддржува нашата поддршка на чатбот!

---

Предуслови

Пред да започнете, осигурајте се дека имате:

• Активен AI SmartTalk акаунт
• Docusaurus сајт со валиден sitemap.xml
• Вашиот сајт мора да биде јавно достапен (или да обезбеди автентикација)

---

Поставување чекор по чекор

Чекор 1: Лоцирајте ја вашата мапа на страниците

Docusaurus автоматски генерира мапа на страниците. Најдете ја на:

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

Проверете дали се вчитува во вашиот прелистувач и содржи ваши страници со документација.

Чекор 2: Додајте ја интеграцијата на Docusaurus

1. Најавете се во вашиот AI SmartTalk акаунт
2. Оди на Поставки → Интеграции
3. Најдете Docusaurus и кликнете на Поврзи
4. Внесете ја URL адресата на вашата мапа на страниците
5. Кликнете на Валидирај

Чекор 3: Конфигурирајте ги поставките за импорт

По валидацијата, конфигурирајте го вашиот импорт:

Поставки	Опис
URL на мапата на страниците	Полната URL адреса до вашиот sitemap.xml
Вклучете образци	Само синхронизирајте страници кои одговараат на образците (опционално)
Исклучете образци	Прескокнете специфични страници или секции (опционално)

Чекор 4: Започнете го импортот

1. Кликнете на Импортирај страници
2. AI SmartTalk ги прегледува секоја URL адреса во вашата мапа на страниците
3. Содржината се извлекува и се додава во вашата база на знаење
4. Чекајте да се заврши импортот (показател за напредокот)

Чекор 5: Потврдете го импортот

1. Оди на Знаење во AI SmartTalk
2. Вашите страници со документација треба да се појават
3. Тестирајте го вашиот AI поставувајќи прашања за вашата документација

---

Што се синхронизира

Содржина	Како се обработува
Наслов на страница	Користи како идентификатор на документот
Содржина на страница	Целосен текст извлечен од HTML
Наслови	Зачувани за структура
Код блокови	Вклучени како што се
Табели	Претворени во читлив формат
URL адреси	URL адресата на страницата се чува за референца

Извлекување на содржина

AI SmartTalk извлекува главниот дел од содржината и игнорира:

• Навигациски менија
• Странични панели
• Футери
• Скрипти и стилови

---

Синхронизација на однесувањето

Рачен увоз

Кликнете на Увоз во поставките за интеграција за да:

• Преземете ја најновата мапа на страниците
• Додадете нови страници
• Ажурирате изменети страници
• Отстраните избришани страници

Одржување на документацијата свежа

За секогаш актуелна документација:

1. Рачно освежување: Кликнете на Увоз по објавување на ажурирања
2. Планирана синхронизација: Користете SmartFlow за автоматизирање на увозите

Планиран увоз со SmartFlow

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

---

УРЛ Шеми

Вклучени шеми

Само синхронизирајте специфични секции:

Шема	Ефект
/docs/api/*	Само API документација
/docs/guides/*	Само делот со водичи
/blog/*	Само блог постови

Исклучени шеми

Прескокнете одредени страници:

Шема	Ефект
/docs/internal/*	Прескокнете внатрешни документи
/changelog	Прескокнете ја страницата со промени
*/draft-*	Прескокнете нацрт страници

---

Случаи на употреба

Технички поддржен бот

Синхронизирајте ја вашата документација за производот:

• "Како да го инсталирам SDK?"
• "Кои се ограничувањата на API-от?"
• "Покажете ми пример за автентикација"

Документација за развивачи

Синхронизирајте референци и водичи за API:

• "Кои параметри прифаќа крајната точка /users?"
• "Како да управувам со веб-хуки?"
• "Која е разликата помеѓу v1 и v2 API?"

Внатрешна база на знаење

Синхронизирајте компанииски вики и процедури:

• "Кој е процесот за барање PTO?"
• "Како да ја поставам мојата развојна средина?"
• "Каде можам да ги најдам упатствата за брендот?"

---

Решавање на проблеми

Проблеми со мапата на страниците

Проблем	Решение
"Невалидна мапа на страниците"	Потврдете дека УРЛ-то враќа валиден XML
"Нема пронајдени страници"	Проверете дали мапата на страниците содржи <url> записи
"Пристапот е забранет"	Осигурајте се дека мапата на страниците е јавно достапна

Проблеми со увозот

Проблем	Решение
Страници недостасуваат	Проверете ги вклучените/исклучените шеми
Увозот заглавен	Големите страници траат време; почекајте или увезувајте во серии
Стари содржини	Повторно увезете за да ги преземете најновите верзии

Квалитет на содржината

Проблем	Решение
Извлечена погрешна содржина	Пријавете го проблемот—можеби е потребно прилагодено извлекување
Недостасуваат код блокови	Потврдете дека кодот е во стандардни <pre><code> тагови
Измешан текст	Проверете ја енкодирањето на страницата (препорачливо е UTF-8)

---

Управување со интеграцијата

Акција	Како
Повторно увезете сè	Кликнете на Увоз во поставките за интеграција
Променете ја мапата на страниците	Ажурирајте го УРЛ-то и повторно увезете
Отстранете содржина	Исклучете ја интеграцијата или избришете од Базата на знаење
Исклучете	Поставки → Интеграции → Docusaurus → Исклучи

Најдобри Практики

1. Квалитетна содржина: Добро напишани документи = подобри AI одговори
2. Јасна структура: Користете наслови, листи и табли
3. Описни наслови: Насловите на страниците помагаат на AI да разбере контекст
4. Редовни синхронизации: Држете го AI ажуриран со најновата документација
5. Темелно тестирање: Поставувајте вообичаени прашања за да ја потврдите точноста на AI

---

Совети за Конфигурација на Docusaurus

Оптимизирајте за AI Извлекување

Во вашиот docusaurus.config.js:

module.exports = {
  // Осигурете се дека мапата на страниците е генерирана
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Користете описни наслови на страниците
  title: 'Вашата Документација за Производот',
  
  // Вклучете метаподатоци
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Документација за Вашиот Производ'
    }],
  },
};

Исклучете Страници од Мапата на Страниците

За да спречите одредени страници да бидат синхронизирани:

// Во предната матрица на страницата
---
title: Внатрешна Страница
sitemap:
  exclude: true
---

---

Поврзана Документација

• Преглед на Интеграции
• Управување со База на Знаење
• Интеграција на RSS Фид — За блог/вести
• Планирани Тригери на SmartFlow — Автоматизирајте увоз