Docusaurus

Sync your Docusaurus documentation site into AI SmartTalk's knowledge base. Your AI will learn from every page in your sitemap—perfect for support bots that answer technical questions.

---

Overview

The Docusaurus integration enables you to:

• Import all pages from your sitemap automatically
• Keep docs synced when you publish updates
• Answer questions about your documentation conversationally
• Reduce support load by letting AI handle common questions

Fun fact: AI SmartTalk's own documentation uses Docusaurus, and this integration powers our support chatbot!

---

Prerequisites

Before you begin, ensure you have:

• An active AI SmartTalk account
• A Docusaurus site with a valid sitemap.xml
• Your site must be publicly accessible (or provide authentication)

---

Step-by-Step Setup

Step 1: Locate Your Sitemap

Docusaurus automatically generates a sitemap. Find it at:

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

Verify it loads in your browser and contains your documentation pages.

Step 2: Add the Docusaurus Integration

1. Log into your AI SmartTalk account
2. Navigate to Settings → Integrations
3. Find Docusaurus and click Connect
4. Enter your sitemap URL
5. Click Validate

Step 3: Configure Import Settings

After validation, configure your import:

Setting	Description
Sitemap URL	Full URL to your sitemap.xml
Include patterns	Only sync pages matching patterns (optional)
Exclude patterns	Skip specific pages or sections (optional)

Step 4: Start the Import

1. Click Import Pages
2. AI SmartTalk crawls each URL in your sitemap
3. Content is extracted and added to your knowledge base
4. Wait for the import to complete (progress shown)

Step 5: Verify the Import

1. Go to Knowledge in AI SmartTalk
2. Your documentation pages should appear
3. Test your AI by asking questions about your docs

---

What Gets Synced

Content	How It's Processed
Page title	Used as document identifier
Page content	Full text extracted from HTML
Headings	Preserved for structure
Code blocks	Included as-is
Tables	Converted to readable format
URLs	Page URL stored for reference

Content Extraction

AI SmartTalk extracts the main content area and ignores:

• Navigation menus
• Sidebars
• Footers
• Scripts and styles

---

Սինխրոնացման վարք

Հրապարակային ներմուծում

Սեղմեք Ներմուծել ինտեգրման կարգավորումներում, որպեսզի.

• Վերցնեք վերջին կայքի քարտեզը
• Ավելացրեք նոր էջեր
• Թարմացրեք փոխված էջերը
• Հեռացրեք ջնջված էջերը

Փաստաթղթերի թարմ պահելը

Ամեն ժամանակ արդիական փաստաթղթերի համար.

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 վերջնակետին ընդունվող պարամետրերը?"
• "Ինչպես պետք է աշխատեմ webhooks-ի հետ?"
• "Ինչ է տարբերությունը 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 = {
  // Ensure sitemap is generated
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Use descriptive page titles
  title: 'Your Product Docs',
  
  // Include metadata
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Documentation for Your Product'
    }],
  },
};

Բացառեք Էջերը Sitemap-ից

Certain pages-ները համաժամեցումից խուսափելու համար:

// In page frontmatter
---
title: Internal Page
sitemap:
  exclude: true
---

---

Հասարակ փաստաթղթեր

• Ինտեգրումների Ընդհանուր Նկարագրություն
• Գիտելիքների Բազայի Կառավարում
• RSS Գործընկերության Ինտեգրացում — Blog/նորություններ բովանդակության համար
• SmartFlow Ժամանակացույցով Տեղեկատվություններ — Ավտոմատացրեք ներմուծումները