Skip to content

Introducción (Astro Docs)

El motor de documentación de Lynx está construido sobre Astro, un framework moderno diseñado para la entrega de contenido web ultrarrápido con un enfoque en el rendimiento estático.

Esta aplicación tiene como propósito centralizar el conocimiento técnico del ecosistema, proporcionando una experiencia de lectura fluida y herramientas de búsqueda avanzadas mediante Starlight.

La infraestructura de documentación utiliza componentes líderes en la industria para garantizar una base extensible y profesional:

  • Starlight: Framework de documentación que gestiona de forma nativa el i18n, la búsqueda y la navegación.
  • Ion Theme: Sistema visual optimizado para la legibilidad de documentos técnicos extensos.
  • Mermaid: Motor de diagramación que permite representar arquitecturas complejas mediante código.
  • Sentry: Monitoreo y rastreo de errores en tiempo real para asegurar la disponibilidad de la documentación.

Es fundamental distinguir el propósito de cada herramienta dentro del ecosistema:

[!NOTE] Mientras que el Storybook de @lynx/ui es la referencia visual para componentes atómicos de interfaz, Astro Docs es el recurso central para la arquitectura lógica, guías de implementación y estándares de ingeniería.

CaracterísticaStorybook (@lynx/ui)Astro Docs (@lynx/astro)
EnfoqueUI / FrontendLógica / Arquitectura
PúblicoDesarrolladores FrontendIngenieros de Sistema
InteractividadSandbox de ComponentesGuías y Diagramas

Para conocer cómo extender o mantener este sistema, consulte la sección de Arquitectura Lógica.