Para desarrolladores
Documentación técnica para desarrolladores, colaboradores y quienes mantienen versiones fork de Telar.
Para quién es esta sección
Esta sección está diseñada para:
- Desarrolladores que construyen funcionalidades o arreglan errores en Telar
- Mantenedores de versiones fork de Telar para instituciones específicas
- Colaboradores que quieren entender la arquitectura de Telar
- Usuarios avanzados que resuelven problemas del build o personalizan Telar
Si estás creando el contenido de un sitio de Telar, lo que probablemente necesitas son las secciones principales de la documentación.
Qué hay en esta sección
8.1 Desarrollo local
Configura tu entorno de desarrollo, construye el sitio en tu computador y prueba los cambios antes de publicarlos.
8.2 GitHub Actions
Entiende cómo el flujo de trabajo Build and Deploy construye y publica el sitio, y cómo personalizarlo.
8.3 Arquitectura del contenido de demostración
Aprende cómo funciona el sistema de obtención de contenido de demostración, desde el emparejamiento de versiones hasta la integración de paquetes.
8.4 Arquitectura del sistema de inserción
Detalles técnicos del sistema de inserción iframe de Telar y cómo maneja diferentes contextos.
8.5 Estilos avanzados
Personaliza los estilos de Telar con CSS propio, variables de CSS y capas de cascada.
8.6 Diseños y pantallas pequeñas
Cómo escoge la página de una historia entre sus dos diseños y cómo se adapta el sitio a las ventanas pequeñas o bajas.
8.7 Vocabulario del motor de historias
Los términos con que el código del motor de historias y esta documentación nombran las partes de una historia, sus movimientos y sus diseños.
Contribuir a Telar
Telar es código abierto y recibe contribuciones con gusto. Antes de contribuir:
- Configura desarrollo local (8.1) para probar tus cambios
- Entiende cómo se construye el sitio (8.2, 8.3) para ver de qué manera se procesa el contenido
- Sigue los patrones existentes en el código base
- Prueba exhaustivamente antes de enviar pull requests
Repositorio: UCSB-AMPLab/telar
Obtener ayuda
- Issues: Reporta errores o solicita funcionalidades en GitHub Issues
- Discussions: Haz preguntas en GitHub Discussions
- Email: Contacta a los mantenedores para problemas sensibles o alianzas institucionales
Enlaces rápidos
- Documentación principal - Documentación para quienes crean contenido
- Referencia de configuración - Todas las opciones de _config.yml
- Referencia CSV: Proyecto - Documentación de columnas CSV