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

---

URL шаблони

Включване на шаблони

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

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

Изключване на шаблони

Пропуснете определени страници:

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

---

Сценарии на употреба

Бот за техническа поддръжка

Синхронизирайте документацията на продукта:

• "Как да инсталирам SDK?"
• "Какви са лимитите на API заявките?"
• "Покажете ми пример за удостоверяване"

Документация за разработчици

Синхронизирайте API референции и ръководства:

• "Какви параметри приема крайният точка /users?"
• "Как да обработвам уебхукове?"
• "Каква е разликата между v1 и v2 API?"

Вътрешна база знания

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

• "Какъв е процесът за искане на отпуск?"
• "Как да настроя средата за разработка?"
• "Къде мога да намеря указанията за бранда?"

---

Отстраняване на проблеми

Проблеми с картата на сайта

Проблем	Решение
"Невалидна карта на сайта"	Проверете дали URL адресът връща валиден XML
"Не са намерени страници"	Проверете дали картата на сайта съдържа записи <url>
"Достъпът е отказан"	Уверете се, че картата на сайта е публично достъпна

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

Проблем	Решение
Липсващи страници	Проверете шаблоните за включване/изключване
Импортът е блокиран	Големите сайтове отнемат време; изчакайте или импортирайте на партиди
Стара съдържание	Повторен импорт, за да получите най-новите версии

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

Проблем	Решение
Извлечено грешно съдържание	Докладвайте проблема—може да се наложи персонализирано извличане
Липсващи кодови блокове	Проверете дали кодът е в стандартни <pre><code> тагове
Разбъркан текст	Проверете кодирането на страницата (препоръчително е UTF-8)

---

Управление на интеграцията

Действие	Как
Повторен импорт на всичко	Кликнете на Импорт в настройките на интеграцията
Смяна на картата на сайта	Актуализирайте URL адреса и повторно импортирайте
Премахване на съдържание	Прекратете интеграцията или изтрийте от Knowledge
Прекъсване на връзката	Настройки → Интеграции → 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 — Автоматизиране на импорти