Docusaurus

Synchronizuj swoją stronę dokumentacyjną Docusaurus z bazą wiedzy AI SmartTalk. Twój AI nauczy się z każdej strony w Twojej mapie witryny — idealne dla botów wsparcia, które odpowiadają na pytania techniczne.

---

Przegląd

Integracja Docusaurus umożliwia Ci:

• Importowanie wszystkich stron z Twojej mapy witryny automatycznie
• Utrzymywanie synchronizacji dokumentów podczas publikacji aktualizacji
• Odpowiadanie na pytania dotyczące Twojej dokumentacji w sposób konwersacyjny
• Zmniejszenie obciążenia wsparcia poprzez pozwolenie AI na obsługę powszechnych pytań

Ciekawostka: Dokumentacja AI SmartTalk korzysta z Docusaurus, a ta integracja napędza naszego chatbota wsparcia!

---

Wymagania wstępne

Zanim zaczniesz, upewnij się, że masz:

• Aktywne konto AI SmartTalk
• Stronę Docusaurus z ważnym sitemap.xml
• Twoja strona musi być publicznie dostępna (lub zapewnić uwierzytelnienie)

---

Instrukcja krok po kroku

Krok 1: Zlokalizuj swoją mapę witryny

Docusaurus automatycznie generuje mapę witryny. Znajdź ją pod adresem:

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

Sprawdź, czy ładuje się w Twojej przeglądarce i zawiera strony Twojej dokumentacji.

Krok 2: Dodaj integrację Docusaurus

1. Zaloguj się na swoje konto AI SmartTalk
2. Przejdź do Ustawienia → Integracje
3. Znajdź Docusaurus i kliknij Połącz
4. Wprowadź adres URL swojej mapy witryny
5. Kliknij Waliduj

Krok 3: Skonfiguruj ustawienia importu

Po walidacji skonfiguruj swój import:

Ustawienie	Opis
Adres URL mapy witryny	Pełny adres URL do Twojego sitemap.xml
Wzory do uwzględnienia	Synchronizuj tylko strony pasujące do wzorów (opcjonalnie)
Wzory do wykluczenia	Pomiń konkretne strony lub sekcje (opcjonalnie)

Krok 4: Rozpocznij import

1. Kliknij Importuj strony
2. AI SmartTalk przeszukuje każdy adres URL w Twojej mapie witryny
3. Treść jest wyodrębniana i dodawana do Twojej bazy wiedzy
4. Poczekaj na zakończenie importu (pokazywany postęp)

Krok 5: Zweryfikuj import

1. Przejdź do Wiedza w AI SmartTalk
2. Twoje strony dokumentacji powinny się pojawić
3. Przetestuj swojego AI, zadając pytania dotyczące Twojej dokumentacji

---

Co jest synchronizowane

Treść	Jak jest przetwarzana
Tytuł strony	Używany jako identyfikator dokumentu
Treść strony	Pełny tekst wyodrębniony z HTML
Nagłówki	Zachowane dla struktury
Bloki kodu	Dołączone w oryginalnej formie
Tabele	Przekształcone na czytelny format
Adresy URL	Adres URL strony przechowywany do odniesienia

Ekstrakcja treści

AI SmartTalk wyodrębnia główny obszar treści i ignoruje:

• Menu nawigacyjne
• Paski boczne
• Stopki
• Skrypty i style

---

Zachowanie synchronizacji

Ręczny import

Kliknij Importuj w ustawieniach integracji, aby:

• Pobierać najnowszą mapę witryny
• Dodawać nowe strony
• Aktualizować zmienione strony
• Usuwać usunięte strony

Utrzymywanie dokumentacji w aktualności

Aby dokumentacja była zawsze aktualna:

1. Ręczne odświeżenie: Kliknij Importuj po opublikowaniu aktualizacji
2. Zaplanuj synchronizację: Użyj SmartFlow, aby zautomatyzować importy

Zaplanowany import SmartFlow

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

---

Wzorce URL

Wzorce do uwzględnienia

Synchronizuj tylko określone sekcje:

Wzorzec	Efekt
/docs/api/*	Tylko dokumentacja API
/docs/guides/*	Tylko sekcja przewodników
/blog/*	Tylko posty na blogu

Wzorce do wykluczenia

Pomiń niektóre strony:

Wzorzec	Efekt
/docs/internal/*	Pomiń dokumenty wewnętrzne
/changelog	Pomiń stronę changeloga
*/draft-*	Pomiń strony robocze

---

Przykłady użycia

Bot wsparcia technicznego

Synchronizuj dokumentację swojego produktu:

• "Jak zainstalować SDK?"
• "Jakie są limity API?"
• "Pokaż mi przykład autoryzacji"

Dokumentacja dla deweloperów

Synchronizuj odniesienia do API i przewodniki:

• "Jakie parametry akceptuje punkt końcowy /users?"
• "Jak obsługiwać webhooks?"
• "Jaka jest różnica między API v1 a v2?"

Wewnętrzna baza wiedzy

Synchronizuj wiki i procedury firmy:

• "Jaki jest proces składania wniosków o urlop?"
• "Jak skonfigurować moje środowisko deweloperskie?"
• "Gdzie znajdę wytyczne dotyczące marki?"

---

Rozwiązywanie problemów

Problemy z mapą witryny

Problem	Rozwiązanie
"Nieprawidłowa mapa witryny"	Sprawdź, czy URL zwraca prawidłowy XML
"Nie znaleziono stron"	Sprawdź, czy mapa witryny zawiera wpisy <url>
"Dostęp zabroniony"	Upewnij się, że mapa witryny jest publicznie dostępna

Problemy z importem

Problem	Rozwiązanie
Brakujące strony	Sprawdź wzorce uwzględnienia/wykluczenia
Import utknął	Duże witryny zajmują czas; poczekaj lub importuj w partiach
Stare treści	Ponownie zaimportuj, aby pobrać najnowsze wersje

Jakość treści

Problem	Rozwiązanie
Wyciągnięte niewłaściwe treści	Zgłoś problem—może być potrzebne niestandardowe wyciąganie
Brakujące bloki kodu	Sprawdź, czy kod jest w standardowych tagach <pre><code>
Zniekształcony tekst	Sprawdź kodowanie strony (zalecane UTF-8)

---

Zarządzanie integracją

Akcja	Jak
Ponowny import wszystkich	Kliknij Importuj w ustawieniach integracji
Zmień mapę witryny	Zaktualizuj URL i ponownie zaimportuj
Usuń treść	Odłącz integrację lub usuń z Bazy Wiedzy
Odłącz	Ustawienia → Integracje → Docusaurus → Odłącz

Najlepsze Praktyki

1. Jakość treści: Dobrze napisane dokumenty = lepsze odpowiedzi AI
2. Jasna struktura: Używaj nagłówków, list i tabel
3. Opisowe tytuły: Tytuły stron pomagają AI zrozumieć kontekst
4. Regularne synchronizacje: Utrzymuj AI w aktualności z najnowszą dokumentacją
5. Dokładne testowanie: Zadawaj powszechne pytania, aby zweryfikować dokładność AI

---

Wskazówki dotyczące konfiguracji Docusaurus

Optymalizacja pod kątem ekstrakcji AI

W pliku docusaurus.config.js:

module.exports = {
  // Upewnij się, że mapa witryny jest generowana
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Używaj opisowych tytułów stron
  title: 'Dokumentacja Twojego Produktu',
  
  // Dołącz metadane
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentacja dla Twojego Produktu'
    }],
  },
};

Wykluczanie stron z mapy witryny

Aby zapobiec synchronizacji niektórych stron:

// W frontmatter strony
---
title: Strona wewnętrzna
sitemap:
  exclude: true
---

---

Powiązana Dokumentacja

• Przegląd Integracji
• Zarządzanie Bazą Wiedzy
• Integracja z RSS Feed — Dla treści bloga/aktualności
• Zaplanowane Wyzwalacze SmartFlow — Automatyzacja importów