Saltar al contenido principal
Soporte para documentación de Docusaurus

Añade un chatbot de IA con citas de fuentes a tu documentación de Docusaurus

Un chatbot de IA para Docusaurus para redactores técnicos, DevRel y equipos de soporte. ChattyBox rastrea tu documentación de Docusaurus y puede enlazar las respuestas a páginas recuperadas. Comprueba la precisión de las respuestas y las citas. Sin RAG personalizado ni migración.

Rastrea páginas de documentación publicadasRespuestas con citas de fuentesIncrustado con un scriptNo se requiere migración de documentosNo se requiere tarjeta de créditoTu contenido sigue siendo tuyo
Preguntar a ChattyBox
¿Por dónde debería empezar si necesito una respuesta fiable de este sitio?
Empieza añadiendo la URL pública de tu sitio a ChattyBox. Recupera contenido indexado para orientar las respuestas y puede mostrar enlaces a páginas fuente para que los visitantes las revisen. Prueba las respuestas y los mensajes de respaldo antes del lanzamiento.
iFuentes3^
Docusaurus guía
chattybox.ai
Analítica
chattybox.ai
Inicio
chattybox.ai

Conversación ilustrativa: no es un chat en directo.

Con tecnología de ChattyBox
Configuración de autoservicio

No se requiere llamada de ventas

Algunas herramientas de soporte de IA le obligan a reservar una demostración incluso antes de que pueda probar el producto. ChattyBox es de autoservicio: agregue su sitio, rastree sus documentos, pruebe el chatbot e insértelo cuando esté listo.

Herramientas tradicionales de soporte de IA

  • Reserva una demostración
  • Precios ocultos o disponibles a través del equipo de ventas
  • Centrado en grandes empresas
  • Conversación de ventas primero

Configuración de autoservicio

ChattyBox

  • Comience de inmediato
  • Precios públicos
  • Creado para sitios de documentos, equipos pequeños, OSS y SaaS
  • Pruébelo usted mismo primero

Lance un chatbot con citas de fuentes sin reconstruir su pila web

ChattyBox rastrea tu sitio web, documentación, centro de ayuda, CMS o base de conocimientos existentes. El contenido recuperado puede orientar las respuestas del chatbot; comprueba la precisión de las respuestas y las citas.

Un wrapper Root de Docusaurus 3 carga el widget una sola vez durante toda la vida de la aplicación cliente.
El alcance del rastreo puede seguir rutas de documentación actuales, versionadas, localizadas o filtradas deliberadamente.
Las citas pueden enlazar a los lectores con páginas de Docusaurus recuperadas. Comprueba la respuesta y la ruta de versión e idioma.
El ejemplo reproducible cubre la prevención de duplicados, la navegación de cliente, la CSP y la verificación a nivel de ruta.
Paso del flujo de trabajo

Elige el sitemap de producción de Docusaurus o un conjunto intencional de rutas de documentación actuales, versionadas y localizadas.

Paso del flujo de trabajo

Rastrea las rutas seleccionadas y luego prueba preguntas contra la versión y el idioma exactos que usan tus visitantes.

Paso del flujo de trabajo

Instala un único cargador persistente en src/theme/Root.tsx y permite los orígenes de su script y de su API en tu Política de Seguridad de Contenido.

Paso del flujo de trabajo

Navega entre páginas de documentación sin recarga y verifica una sola instancia del widget, citas funcionales y sin errores de consola o de CSP.

Lanzamiento en tres pasos

Pegue la URL de Docusaurus, pruebe las respuestas con citas y luego instale el widget.

Evidencia editorial probada

Una integración probada de Docusaurus 3, no un script a nivel de ruta

Docusaurus renderiza una aplicación React persistente en torno a los cambios de ruta del lado del cliente. El wrapper Root probado, por tanto, crea un único cargador, reconoce los montajes posteriores por ID y deja el cargador en su sitio en lugar de eliminar un widget aún activo durante los remontajes de desarrollo.

Autor técnico
Equipo de documentación de ChattyBox
Revisor técnico
Ingeniería de ChattyBox
Última actualización
Información verificada
Docusaurus 3.10 y el widget actual de ChattyBox

Vuelve a comprobar el ciclo de vida de Root, la salida del sitemap y los orígenes de CSP tras una actualización importante de Docusaurus o un cambio de endpoint del widget.

Componente Root de Docusaurus que evita un script duplicado de ChattyBox tras la navegación de cliente
Referencia de instalación original: el cargador tiene un ID estable, se carga de forma asíncrona y permanece presente mientras Docusaurus cambia de rutas.
Decisiones de instalación de Docusaurus 3 y sus comprobaciones de extremo a extremo.
Preocupación de DocusaurusDecisión de implementaciónVerificación
Preocupación de Docusaurus
Root y navegación de cliente
Decisión de implementación
Crea el script asíncrono una sola vez mediante un ID estable. No devuelvas una limpieza desde el efecto porque Root y el widget están pensados para persistir entre rutas.
Verificación
Abre dos enlaces internos de documentación y confirma que document.querySelectorAll("#chattybox-widget").length es 1.
Preocupación de Docusaurus
Política de Seguridad de Contenido
Decisión de implementación
Permite chattybox.ai en script-src, el origen configurado de la API en connect-src, fonts.googleapis.com en style-src y fonts.gstatic.com en font-src. El widget actual inyecta su CSS de componente, de modo que un style-src estricto también necesita 'unsafe-inline' hasta que exista una compilación con nonce o con hoja de estilos externa.
Verificación
Recarga con DevTools abierto y confirma que no haya solicitudes de script, estilo, fuente, fetch o WebSocket bloqueadas.
Preocupación de Docusaurus
Versiones, idiomas y alcance del sitemap
Decisión de implementación
Inspecciona el sitemap desplegado antes de rastrear. Incluye solo las rutas de versión e idioma compatibles. Para ámbitos de versión separados, usa proyectos separados con únicamente las páginas previstas en cada uno y comprueba si hay respuestas que mezclen versiones.
Verificación
Haz la misma pregunta específica de versión en cada idioma indexado y comprueba que cada cita conserve el prefijo de ruta esperado.
Preocupación de Docusaurus
Widget faltante o duplicado
Decisión de implementación
Comprueba la clave de API, el ID del cargador, los mensajes de consola de CSP, la respuesta del script y si otro componente del tema también inyecta el widget.
Verificación
Prueba una compilación de producción, no solo la recarga en caliente, e inspecciona los paneles de Elements y Network tras la navegación.
Comprobación de respuesta citada

Prueba una respuesta donde la ruta de versión importa

Una prueba de aceptación útil pregunta por un ajuste cuya respuesta puede diferir según la versión y luego abre la cita para verificar tanto la afirmación como la URL versionada.

Lista de verificación práctica para evaluar chatbots de IA para documentación
Pregunta a la documentación de Docusaurus
¿Cómo hago que la documentación estable más reciente se abra por defecto?
En la configuración del complemento de documentación, define lastVersion con la versión que deben abrir los visitantes y usa onlyIncludeVersions cuando necesites limitar las versiones publicadas. Conserva la ruta de documentación actual solo si quieres que los usuarios accedan a documentación de una versión aún no lanzada.

Conversación ilustrativa: no es un chat en directo.

Con tecnología de ChattyBox
Respuesta de ChattyBox sobre la versión predeterminada de Docusaurus con una cita a la guía de versionado
Referencia de resultado original: la respuesta nombra los ajustes de versión relevantes y expone la guía oficial de versionado como evidencia.
Ruta de instalación

Cómo agregar ChattyBox a Docusaurus

Crea un componente Root del tema de Docusaurus, añade el script del widget después de rastrear tus documentos y despliégalo. Tus visitantes podrán entonces hacer preguntas desde cualquier página de documentos.

  1. 1Cree un proyecto ChattyBox e ingrese la URL o el mapa del sitio de sus documentos de Docusaurus.
  2. 2Pruebe preguntas reales de Docusaurus en el panel y confirme que las citas apunten a las páginas correctas.
  3. 3Agregue el script del widget en src/theme/Root.tsx para que se cargue en su sitio de documentación.
src/theme/Root.tsx
tsx
import React, { useEffect, type ReactNode } from 'react';

const WIDGET_ID = 'chattybox-widget';

export default function Root({ children }: { children: ReactNode }) {
  useEffect(() => {
    if (document.getElementById(WIDGET_ID)) return;

    const script = document.createElement('script');
    script.id = WIDGET_ID;
    script.src = 'https://chattybox.ai/widget.js';
    script.async = true;
    script.dataset.apiKey = 'YOUR_API_KEY';
    script.dataset.apiUrl = 'https://adorable-woodpecker-629.convex.site/chat';
    script.dataset.chattyboxWidget = 'true';
    document.body.appendChild(script);
  }, []);

  return <>{children}</>;
}
Preguntas frecuentes

Preguntas comunes

1

¿Puede ChattyBox rastrear un sitio Docusaurus?

Sí. ChattyBox puede rastrear páginas de documentación públicas Docusaurus o utilizar una URL de mapa del sitio para descubrir contenido de documentos.

2

¿Necesito cambiar mi tema Docusaurus?

No. Usted integra ChattyBox con una etiqueta de secuencia de comandos, por lo que funciona junto con su tema e implementación Docusaurus existentes.

3

¿Las respuestas se vincularán a las páginas Docusaurus?

Las respuestas pueden enlazar a páginas de documentación recuperadas, pero las respuestas alternativas pueden no tener fuentes. Comprueba la precisión de las respuestas y las citas.

4

¿Puedo probar el bot antes de instalarlo?

Sí. Puede probar el contenido extraído en el panel antes de copiar el fragmento del widget a su sitio Docusaurus.