Docusaurus

Sincroniza tu sitio de documentación Docusaurus en la base de conocimientos de AI SmartTalk. Tu IA aprenderá de cada página en tu mapa del sitio, ¡perfecto para bots de soporte que responden preguntas técnicas!

---

Descripción general

La integración de Docusaurus te permite:

• Importar todas las páginas de tu mapa del sitio automáticamente
• Mantener la documentación sincronizada cuando publiques actualizaciones
• Responder preguntas sobre tu documentación de manera conversacional
• Reducir la carga de soporte permitiendo que la IA maneje preguntas comunes

Dato curioso: La propia documentación de AI SmartTalk utiliza Docusaurus, ¡y esta integración potencia nuestro chatbot de soporte!

---

Requisitos previos

Antes de comenzar, asegúrate de tener:

• Una cuenta activa de AI SmartTalk
• Un sitio de Docusaurus con un sitemap.xml válido
• Tu sitio debe ser accesible públicamente (o proporcionar autenticación)

---

Configuración paso a paso

Paso 1: Localiza tu Mapa del Sitio

Docusaurus genera automáticamente un mapa del sitio. Encuéntralo en:

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

Verifica que se cargue en tu navegador y contenga tus páginas de documentación.

Paso 2: Agrega la Integración de Docusaurus

1. Inicia sesión en tu cuenta de AI SmartTalk
2. Navega a Configuración → Integraciones
3. Busca Docusaurus y haz clic en Conectar
4. Ingresa la URL de tu mapa del sitio
5. Haz clic en Validar

Paso 3: Configura la Configuración de Importación

Después de la validación, configura tu importación:

Configuración	Descripción
URL del Mapa del Sitio	URL completa a tu sitemap.xml
Patrones de inclusión	Sincroniza solo páginas que coincidan con patrones (opcional)
Patrones de exclusión	Omite páginas o secciones específicas (opcional)

Paso 4: Inicia la Importación

1. Haz clic en Importar Páginas
2. AI SmartTalk rastrea cada URL en tu mapa del sitio
3. El contenido se extrae y se agrega a tu base de conocimientos
4. Espera a que la importación se complete (progreso mostrado)

Paso 5: Verifica la Importación

1. Ve a Conocimiento en AI SmartTalk
2. Tus páginas de documentación deberían aparecer
3. Prueba tu IA haciendo preguntas sobre tus documentos

---

Qué se Sincroniza

Contenido	Cómo se Procesa
Título de la página	Usado como identificador del documento
Contenido de la página	Texto completo extraído del HTML
Encabezados	Conservados para la estructura
Bloques de código	Incluidos tal como están
Tablas	Convertidas a formato legible
URLs	URL de la página almacenada para referencia

Extracción de Contenido

AI SmartTalk extrae el área principal de contenido e ignora:

• Menús de navegación
• Barras laterales
• Pies de página
• Scripts y estilos

---

Comportamiento de Sincronización

Importación Manual

Haz clic en Importar en la configuración de integración para:

• Obtener el último mapa del sitio
• Agregar nuevas páginas
• Actualizar páginas cambiadas
• Eliminar páginas eliminadas

Manteniendo la Documentación Actualizada

Para documentación siempre actual:

1. Actualización manual: Haz clic en Importar después de publicar actualizaciones
2. Sincronización programada: Usa SmartFlow para automatizar importaciones

Importación Programada de SmartFlow

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

---

Patrones de URL

Patrones de Inclusión

Sincroniza solo secciones específicas:

Patrón	Efecto
/docs/api/*	Solo documentación de API
/docs/guides/*	Solo sección de guías
/blog/*	Solo publicaciones del blog

Patrones de Exclusión

Omite ciertas páginas:

Patrón	Efecto
/docs/internal/*	Omite documentación interna
/changelog	Omite la página de registro de cambios
*/draft-*	Omite páginas en borrador

---

Casos de Uso

Bot de Soporte Técnico

Sincroniza tu documentación de producto:

• "¿Cómo instalo el SDK?"
• "¿Cuáles son los límites de tasa de la API?"
• "Muéstrame un ejemplo de autenticación"

Documentación para Desarrolladores

Sincroniza referencias y guías de API:

• "¿Qué parámetros acepta el endpoint /users?"
• "¿Cómo manejo webhooks?"
• "¿Cuál es la diferencia entre la API v1 y v2?"

Base de Conocimientos Interna

Sincroniza wikis y procedimientos de la empresa:

• "¿Cuál es el proceso para solicitar PTO?"
• "¿Cómo configuro mi entorno de desarrollo?"
• "¿Dónde encuentro las pautas de marca?"

---

Solución de Problemas

Problemas con el Mapa del Sitio

Problema	Solución
"Mapa del sitio inválido"	Verifica que la URL devuelva XML válido
"No se encontraron páginas"	Verifica que el mapa del sitio contenga entradas <url>
"Acceso denegado"	Asegúrate de que el mapa del sitio sea accesible públicamente

Problemas de Importación

Problema	Solución
Páginas faltantes	Verifica patrones de inclusión/exclusión
Importación atascada	Los sitios grandes tardan tiempo; espera o importa en lotes
Contenido antiguo	Reimporta para obtener las versiones más recientes

Calidad del Contenido

Problema	Solución
Contenido incorrecto extraído	Informa del problema; puede necesitar extracción personalizada
Faltan bloques de código	Verifica que el código esté en etiquetas estándar <pre><code>
Texto desordenado	Verifica la codificación de la página (se recomienda UTF-8)

---

Gestión de la Integración

Acción	Cómo
Reimportar todo	Haz clic en Importar en la configuración de integración
Cambiar mapa del sitio	Actualiza la URL y reimporta
Eliminar contenido	Desconecta la integración o elimina de Conocimiento
Desconectar	Configuración → Integraciones → Docusaurus → Desconectar

---

Mejores Prácticas

1. Contenido de calidad: Documentos bien escritos = mejores respuestas de IA
2. Estructura clara: Usa encabezados, listas y tablas
3. Títulos descriptivos: Los títulos de las páginas ayudan a la IA a entender el contexto
4. Sincronizaciones regulares: Mantén la IA actualizada con la documentación más reciente
5. Prueba a fondo: Haz preguntas comunes para verificar la precisión de la IA

---

Consejos de Configuración de Docusaurus

Optimiza para la Extracción de IA

En tu docusaurus.config.js:

module.exports = {
  // Asegúrate de que se genere el mapa del sitio
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Usa títulos de página descriptivos
  title: 'Documentación de Tu Producto',
  
  // Incluye metadatos
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Documentación para Tu Producto'
    }],
  },
};

Excluir Páginas del Mapa del Sitio

Para evitar que ciertas páginas se sincronicen:

// En el frontmatter de la página
---
title: Página Interna
sitemap:
  exclude: true
---

---

Documentación Relacionada

• Descripción general de Integraciones
• Gestión de la Base de Conocimientos
• Integración de RSS Feed — Para contenido de blog/noticias
• Disparadores Programados de SmartFlow — Automatiza importaciones