Sitio 'Cómo funciona'
Genera una presentación sin dependencias en site/ que explica una base de código desde el por qué hasta el código, con demos interactivas que reflejan la lógica real del proyecto, además de un trabajo de CI que lo publica. Implementación de referencia:
https://mveplus.github.io/onair-led-sign-firmware/ (19 diapositivas, 4 simulaciones; fuente en
https://github.com/mveplus/onair-led-sign-firmware/tree/main/site).
Plantillas en el directorio templates/ de esta habilidad:
| Archivo | Copiar a | Propósito |
|---|---|---|
index.html | site/index.html | Marco de página + patrones de diapositivas para clonar |
deck.css | site/deck.css | Tokens de tema, diseño, componentes |
deck.js | site/deck.js | Navegación, vista general, enrutamiento hash, bucle de fotogramas, ayudante de pasos |
app.js | site/app.js | Inicializador para los demos del proyecto (conexión de pasos, enganche de fotogramas) |
github-pages.yml | .github/workflows/pages.yml | Despliegue en GitHub Pages |
gitlab-ci.yml | fusionar en .gitlab-ci.yml | Despliegue en GitLab Pages |
El código de demostración específico del proyecto va en site/app.js (y los estilos en un site/app.css opcional); mantén deck.js y deck.css genéricos.
Proceso
1. Preguntar antes de construir (una llamada AskUserQuestion)
Primero revisa git remote -v para que la pregunta de alojamiento refleje la realidad. Si el remoto es GitHub y el usuario dice GitLab (o viceversa), pregunta al respecto. Haz como máximo cuatro preguntas:
- Alojamiento: GitHub Pages, GitLab Pages, o ambos.
- Audiencia/profundidad: mixta (primero la idea, luego una inmersión profunda; la opción por defecto), desarrolladores, o no desarrolladores.
- Demos interactivos: ofrece 3–4 candidatos específicos para este proyecto, encontrados con un vistazo rápido (máquinas de estado, lógica de temporización/umbrales, flujos de solicitud, matemáticas o fórmulas, constructores de configuración). multiSelect.
- Opcionalmente: una restricción de idioma o marca, si el repositorio sugiere una.
2. Leer el código correctamente
Lee los puntos de entrada, los módulos principales, el README/documentación y los archivos de CI. Para cada afirmación que las diapositivas harán (tiempos de espera, umbrales, valores predeterminados, temas, puntos finales, lo que borra un reinicio), obténla del código, no del README. Mantén una lista de discrepancias entre documentación y código y puntos muertos (por ejemplo, un trabajo de CI cuyo consumidor no existe). Muestra el comportamiento real del código en las diapositivas e informa la lista al usuario al final. Nunca