Saltar al contenido principal

Referencia de arquitectura técnica

Esta página es para lectores técnicos que necesitan entender cómo está organizado y validado el sitio de documentación de Atomicat.

Estructura del sitio

Atomicat Docs es un sitio de documentación estático construido con Docusaurus. La documentación principal en inglés vive en docs, mientras que la documentación localizada activa vive en las carpetas de locale español y portugués.

ÁreaPropósito
docsFuente de documentación en inglés.
i18n/es/docusaurus-plugin-content-docs/currentDocumentación española activa.
i18n/pt/docusaurus-plugin-content-docs/currentDocumentación portuguesa activa.
staticArchivos públicos estáticos como robots.txt, _redirects, llms.txt y llms-full.txt.
src/utils/schemaData.jsDatos FAQ generados usados para datos estructurados.

Solo los locales configurados en Docusaurus forman parte del build activo. Otras carpetas de locale pueden existir para migración o trabajo histórico, pero no deben tratarse como en vivo a menos que se añadan a la configuración del sitio.

Modelo de rutas

Cada página de documentación usa frontmatter como path, slug, title y description para controlar enrutamiento y metadatos. La ruta en inglés es la ruta base, mientras que las rutas localizadas pueden usar slugs traducidos cuando el archivo del locale los define.

Ejemplos:

  • Inglés: /builder/settings/seo-meta
  • Español: /es/constructor/configuracion/seo-meta
  • Portugués: /pt/construtor/configuracoes/seo-meta

Al añadir enlaces internos, usa rutas que existan en el locale activo. Los enlaces rotos los detecta el build de producción.

Redirects

Las URLs localizadas heredadas o incorrectas se gestionan mediante static/_redirects. Este archivo se copia a la salida del build y debe ser compatible con la plataforma de hosting.

Si el host de despliegue no soporta _redirects, replica las mismas reglas en la configuración de redirect específica del host, como vercel.json, redirects de Cloudflare Pages u otro equivalente.

Robots y sitemap

El sitio publica robots.txt con la ubicación del sitemap:

  • https://help.atomicat.com.br/sitemap.xml

El build de sitemap de Docusaurus también produce archivos de sitemap localizados en carpetas de build por locale. Las páginas hub y playbooks reciben señales de sitemap más fuertes que páginas profundas ordinarias mediante changefreq y priority.

Datos estructurados

El contenido FAQ se escribe en cada página Markdown con FAQAccordion. El archivo generado src/utils/schemaData.js refleja esas preguntas y respuestas para extracción JSON-LD.

Cuando cambia el contenido FAQ, regenera los datos de schema antes del despliegue para que los datos estructurados coincidan con el contenido visible de la página.

Exportaciones legibles por IA

El sitio incluye:

  • static/llms.txt para una visión general compacta legible por IA.
  • static/llms-full.txt para una exportación Markdown completa del contenido de documentación activo.

Actualiza llms-full.txt tras grandes cambios de contenido para que motores de búsqueda y respuesta de IA lean la misma copia que ven los visitantes.

Checklist de validación

Antes de desplegar cambios en la documentación:

  1. Ejecuta el build de producción.
  2. Corrige enlaces rotos reportados por Docusaurus.
  3. Busca lenguaje interno que no debería aparecer en docs orientados al cliente.
  4. Confirma que los locales activos se actualizaron cuando cambia contenido hub en inglés.
  5. Regenera schema FAQ y exportaciones legibles por IA cuando cambien FAQ o bloques de contenido.
  6. Envía o actualiza el sitemap en Google Search Console tras el despliegue cuando cambien páginas sensibles a SEO.

Docs relacionados

  • Vista general de referencia: /referencia/vision-general
  • Categorías de plantillas: /referencia/template-categories
  • Ajustes de metadatos SEO: /constructor/configuracion/seo-meta
  • Herramientas y categorías MCP: /atomicmcp/herramientas-categorias