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?"

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

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

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

---

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

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

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

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

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

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

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

---

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

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