Skip to content

Arquitectura Lógica (Astro Docs)

import { Steps } from ‘@astrojs/starlight/components’;

El diseño técnico de la aplicación de documentación prioriza la simplicidad en la creación de contenido y la eficiencia en su distribución.

Los documentos residen en src/content/docs/ y se organizan jerárquicamente para facilitar su indexación por parte del sistema de búsqueda integrado.

[!TIP] Lynx utiliza el sistema de Content Collections de Astro para garantizar que cada documento cumpla con los esquemas de metadatos requeridos por Starlight.

Para añadir o modificar documentación, se debe seguir un proceso estandarizado que asegura la consistencia visual y técnica:

  1. Definición de Frontmatter: Cada archivo debe iniciar con metadatos descriptivos (título, descripción, etc.).
  2. Uso de MDX: Para elementos interactivos o componentes React, utilice la extensión .mdx.
  3. Diagramación: Utilice bloques de código mermaid para representar flujos lógicos.
  4. Verificación Local: Ejecute el comando pnpm dev para previsualizar los cambios en tiempo real.

La infraestructura se potencia mediante módulos especializados que mejoran la experiencia del desarrollador:

  • Contextual Menu: Provee acciones rápidas y atajos sobre bloques de código para facilitar la interacción con agentes de IA.
  • Full View Mode: Maximiza el área de lectura para sesiones de análisis técnico profundo.
  • Localización Automática: El sistema de i18n detecta los títulos definidos en el código y los proyecta en el sidebar sin necesidad de configuración manual extensiva.

Cada vez que se realiza un cambio en la rama principal, se activa una pipeline de CI que ejecuta los siguientes pasos estratégicos:

graph LR
    Lint[Validación de Código] --> Build[Generación Estática]
    Build --> Optimize[Optimización de Activos]
    Optimize --> Deploy[Despliegue en Edge]

Para más detalles sobre los comandos disponibles, consulte la sección de Scripts.