Introducción
This content is not available in your language yet.
@lynx/astro es la aplicación encargada de la elaboración de landing pages estáticas o documentaciones técnicas. Utiliza Astro como motor principal de renderizado y Starlight como framework de documentación.
La documentación de Lynx (este sitio web) está construido con @lynx/astro
Pila Tecnológica
Sección titulada «Pila Tecnológica»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 relaciones entre componentesmediante código.
- Sentry: Monitoreo y rastreo de errores en tiempo real para asegurar la disponibilidad de la documentación.
Diferencia con otras documentaciones
Sección titulada «Diferencia con otras documentaciones»Es fundamental distinguir el propósito de cada herramienta dentro de Lynx:
| Otra documentación | Ubicación | Propósito |
|---|---|---|
| Librería de componentes | @lynx/ui (enlace pendiente) | Documentar los usos, props, eventos y estados de la librería de componentes |
| Documentación del código | README.md en repositorio | Introducción y comandos principales de la base de código |
| Documentación de código para IA | AGENTS.md, SKILL.md | Instrucciones específicas para agentes de IA de desarrollo |
| Documentación de API | OpenAPI (scalar) (enlace pendiente) | Documentación técnica de los endpoints de la API |
| Documentación de arquitectura del backend | Compodocs (enlace pendiente) | Arquitectura del backend |