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