გამოტოვეთ მთავარ შინაარსზე

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-დან
სათაურებიშენარჩუნებულია სტრუქტურისთვის
კოდის ბლოკებიშედის როგორც არის
ტექსტური ცხრილებიგარდაიქმნება წასაკითხ ფორმატში
URLsგვერდის 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/*მხოლოდ ბლოგის პოსტები

გამორიცხვის ნიმუშები

Certain pages-ის გამოტოვება:

ნიმუშიეფექტი
/docs/internal/*გამოტოვეთ შიდა დოკუმენტაცია
/changelogგამოტოვეთ ცვლილებების ისტორიის გვერდი
*/draft-*გამოტოვეთ პროექტის გვერდები

გამოყენების შემთხვევები

ტექნიკური მხარდაჭერის ბოტი

სინქრონიზაცია თქვენი პროდუქტის დოკუმენტაციისთვის:

  • "როგორ უნდა დავაყენო SDK?"
  • "რა არის API-ს სიჩქარის შეზღუდვები?"
  • "მაჩვენეთ ავტორიზაციის მაგალითი"

დეველოპერის დოკუმენტაცია

სინქრონიზაცია API სარეფერენსაც და სახელმძღვანელოებს:

  • "რომელი პარამეტრები იღებს /users API?"
  • "როგორ უნდა გავმართო webhook-ები?"
  • "რა არის განსხვავება 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: 'Your Product Docs',

// მოიცავს მეტადატას
themeConfig: {
metadata: [{
name: 'description',
content: 'Documentation for Your Product'
}],
},
};

გვერდების გამორიცხვა საიტმაპიდან

Certain გვერდების სინქრონიზაციის თავიდან ასაცილებლად:

// გვერდის ფრონტმატერში
---
title: Internal Page
sitemap:
exclude: true
---

დაკავშირებული დოკუმენტაცია

მზად ხართ თქვენი
მომხმარებლის გამოცდილების გასაუმჯობესებლად?

განავითარეთ AI ასისტენტები, რომლებიც სიამოვნებას ანიჭებენ მომხმარებლებს და იზრდებიან თქვენს ბიზნესთან ერთად.

GDPR-ის შესაბამისი