Docusaurus
Συγχρονίστε τον ιστότοπο τεκμηρίωσης Docusaurus σας με τη βάση γνώσεων του AI SmartTalk. Το AI σας θα μάθει από κάθε σελίδα στον χάρτη ιστότοπού σας—ιδανικό για υποστηρικτικά bots που απαντούν σε τεχνικές ερωτήσεις.
Επισκόπηση
Η ενσωμάτωση Docusaurus σας επιτρέπει να:
- Εισάγετε αυτόματα όλες τις σελίδες από τον χάρτη ιστότοπού σας
- Διατηρείτε συγχρονισμένα τα έγγραφα όταν δημοσιεύετε ενημερώσεις
- Απαντάτε σε ερωτήσεις σχετικά με την τεκμηρίωσή σας με συνομιλησιακό τρόπο
- Μειώνετε το φόρτο υποστήριξης επιτρέποντας στο AI να χειρίζεται κοινές ερωτήσεις
Διασκεδαστικό γεγονός: Η τεκμηρίωση του AI SmartTalk χρησιμοποιεί Docusaurus, και αυτή η ενσωμάτωση τροφοδοτεί το chatbot υποστήριξής μας!
Προαπαιτούμενα
Πριν ξεκινήσετε, βεβαιωθείτε ότι έχετε:
- Έναν ενεργό λογαριασμό AI SmartTalk
- Έναν ιστότοπο Docusaurus με έγκυρο
sitemap.xml - Ο ιστότοπός σας πρέπει να είναι δημόσια προσβάσιμος (ή να παρέχετε αυθεντικοποίηση)
Βήμα-Βήμα Ρύθμιση
Βήμα 1: Εντοπίστε τον Χάρτη Ιστότοπού σας
Ο Docusaurus δημιουργεί αυτόματα έναν χάρτη ιστότοπου. Βρείτε τον στη διεύθυνση:
https://your-docs-site.com/sitemap.xml
Επιβεβαιώστε ότι φορτώνει στον περιηγητή σας και περιέχει τις σελίδες τεκμηρίωσής σας.
Βήμα 2: Προσθέστε την Ενσωμάτωση Docusaurus
- Συνδεθείτε στον λογαριασμό σας στο AI SmartTalk
- Μεταβείτε στις Ρυθμίσεις → Ενσωματώσεις
- Βρείτε το Docusaurus και κάντε κλικ στο Σύνδεση
- Εισάγετε τη διεύθυνση URL του χάρτη ιστότοπού σας
- Κάντε κλικ στο Επικύρωση
Βήμα 3: Ρυθμίστε τις Ρυθμίσεις Εισαγωγής
Μετά την επικύρωση, ρυθμίστε την εισαγωγή σας:
| Ρύθμιση | Περιγραφή |
|---|---|
| Διεύθυνση URL Χάρτη Ιστότοπου | Πλήρης διεύθυνση URL στο sitemap.xml σας |
| Πρότυπα συμπερίληψης | Συγχρονίστε μόνο σελίδες που ταιριάζουν με τα πρότυπα (προαιρετικό) |
| Πρότυπα εξαίρεσης | Παράλειψη συγκεκριμένων σελίδων ή τμημάτων (προαιρετικό) |
Βήμα 4: Ξεκινήστε την Εισαγωγή
- Κάντε κλικ στο Εισαγωγή Σελίδων
- Το AI SmartTalk ανιχνεύει κάθε διεύθυνση URL στον χάρτη ιστότοπού σας
- Το περιεχόμενο εξάγεται και προστίθεται στη βάση γνώσεων σας
- Περιμένετε να ολοκληρωθεί η εισαγωγή (η πρόοδος εμφανίζεται)
Βήμα 5: Επαληθεύστε την Εισαγωγή
- Μεταβείτε στο Γνώση στο AI SmartTalk
- Οι σελίδες τεκμηρίωσής σας θα πρέπει να εμφανίζονται
- Δοκιμάστε το AI σας κάνοντάς του ερωτήσεις σχετικά με τα έγγραφά σας
Τι Συγχρονίζεται
| Περιεχόμενο | Πώς Επεξεργάζεται |
|---|---|
| Τίτλος Σελίδας | Χρησιμοποιείται ως αναγνωριστικό εγγράφου |
| Περιεχόμενο Σελίδας | Πλήρης κείμενο εξαγόμενο από HTML |
| Επικεφαλίδες | Διατηρούνται για τη δομή |
| Κωδικοί | Συμπεριλαμβάνονται όπως είναι |
| Πίνακες | Μετατρέπονται σε αναγνώσιμη μορφή |
| Διευθύνσεις URL | Η διεύθυνση URL της σελίδας αποθηκεύεται για αναφορά |
Εξαγωγή Περιεχομένου
Το AI SmartTalk εξάγει την κύρια περιοχή περιεχομένου και αγνοεί:
- Μενού πλοήγησης
- Πλευρικές μπάρες
- Υποσέλιδα
- Σενάρια και στυλ
Συμπεριφορά Συγχρονισμού
Χειροκίνητη Εισαγωγή
Κάντε κλικ στο Εισαγωγή στις ρυθμίσεις ολοκλήρωσης για να:
- Λάβετε τον τελευταίο χάρτη ιστοσελίδας
- Προσθέσετε νέες σελίδες
- Ενημερώσετε τις τροποποιημένες σελίδες
- Αφαιρέσετε τις διαγραμμένες σελίδες
Διατήρηση Ενημερωμένης Τεκμηρίωσης
Για πάντα ενημερωμένη τεκμηρίωση:
- Χειροκίνητη ανανέωση: Κάντε κλικ στην Εισαγωγή μετά την δημοσίευση ενημερώσεων
- Προγραμματισμένος συγχρονισμός: Χρησιμοποιήστε το 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:
- "Ποιες παράμετροι δέχεται το endpoint /users;"
- "Πώς να χειριστώ webhooks;"
- "Πια είναι η διαφορά μεταξύ v1 και v2 API;"
Εσωτερική Βάση Γνώσεων
Συγχρονίστε τα wiki και τις διαδικασίες της εταιρείας:
- "Πια είναι η διαδικασία για να ζητήσω PTO;"
- "Πώς να ρυθμίσω το περιβάλλον ανάπτυξής μου;"
- "Πού μπορώ να βρω τις οδηγίες για την επωνυμία;"
Αντιμετώπιση Προβλημάτων
Προβλήματα Χάρτη Ιστοσελίδας
| Πρόβλημα | Λύση |
|---|---|
| "Μη έγκυρος χάρτης ιστοσελίδας" | Επαληθεύστε ότι το URL επιστρέφει έγκυρο XML |
| "Καμία σελίδα δεν βρέθηκε" | Ελέγξτε ότι ο χάρτης ιστοσελίδας περιέχει καταχωρήσ εις <url> |
| "Απαγορευμένη πρόσβαση" | Διασφαλίστε ότι ο χάρτης ιστοσελίδας είναι δημόσια προσβάσιμος |
Προβλήματα Εισαγωγής
| Πρόβλημα | Λύση |
|---|---|
| Σελίδες που λείπουν | Ελέγξτε τα πρότυπα συμπερίληψης/εξαίρεσης |
| Εισαγωγή κολλημένη | Μεγάλες ιστοσελίδες χρειάζονται χρόνο; περιμένετε ή εισάγετε σε παρτίδες |
| Παλιό περιεχόμενο | Επαναφέρετε για να λάβετε τις τελευταίες εκδόσεις |
Ποιότητα Περιεχομένου
| Πρόβλημα | Λύση |
|---|---|
| Λάθος περιεχόμενο εξαγόμενο | Αναφέρετε το πρόβλημα—μπορεί να χρειαστεί προσαρμοσμένη εξαγωγή |
| Λείπουν μπλοκ κώδικα | Επαληθεύστε ότι ο κώδικας είναι σε τυ πικές ετικέτες <pre><code> |
| Ακατάληπτο κείμενο | Ελέγξτε την κωδικοποίηση της σελίδας (προτείνεται UTF-8) |
Διαχείριση της Ολοκλήρωσης
| Ενέργεια | Πώς |
|---|---|
| Επαναφορά όλων | Κάντε κλικ στο Εισαγωγή στις ρυθμίσεις ολοκλήρωσης |
| Αλλαγή χάρτη ιστοσελίδας | Ενημερώστε το URL και επαναφέρετε |
| Αφαίρεση περιεχομένου | Αποσυνδέστε την ολοκλήρωση ή διαγράψτε από τη Γνώση |
| Αποσύνδεση | Ρυθμίσεις → Ολοκληρώσεις → Docusaurus → Αποσύνδεση |
Καλύτερες Πρακτικές
- Ποιοτικό περιεχόμενο: Καλά γραμμένα έγγραφα = καλύτερες απαντήσεις AI
- Καθαρή δομ ή: Χρησιμοποιήστε επικεφαλίδες, λίστες και πίνακες
- Περιγραφικοί τίτλοι: Οι τίτλοι σελίδων βοηθούν το AI να κατανοήσει το πλαίσιο
- Τακτικές συγχρονίσεις: Κρατήστε το AI ενημερωμένο με την τελευταία τεκμηρίωση
- Δοκιμάστε διεξοδικά: Κάντε κοινές ερωτήσεις για να επαληθεύσετε την ακρίβεια του 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'
}],
},
};
Αποκλεισμός Σελίδων από τον Χάρτη Ιστοσελίδας
Για να αποτρέψετε ορισμένες σελίδες από το να συγχρονιστούν:
// In page frontmatter
---
title: Internal Page
sitemap:
exclude: true
---