Bienvenidos

👋 Hola!! En esta sección explicaremos cómo usamos y qué encontrarán en la distintas secciones de esta wiki.

Introducción

La documentación por defecto siempre será el código fuente y siempre preferiremos tener software funcionado a documentación extensiva.

Sin embargo, hemos considerado que es importante - tanto para nosotros como para los stakeholders - compartir elementos que permitan un mejor entendimiento del producto.

Escritura

• Todo se hablará en primera persona plural, para tener un lenguaje cercano
• No usamos lenguaje inclusivo, porque no está reconocido por la RAE y porque es muy poco eficiente
• Para que este contenido sea exportable a diferentes motores de markdown, nos aseguramos de escribirlo dando cumplimiento a las normas de estilo más comunes CommonMark Specification
• Código in-line para aludir a cosas relacionadas con el código (nombre variables, comandos etc.)
• Para destacar una palabras, usamos bold y para otro idioma, cursiva
• Bloques de código sólo para código. Para encerrar texto, usar admonitions

Edición

Para quienes tengan permiso de edición, usaremos Linter en la integración continua del repositorio. Para evitar errores (al menos mientras usemos docusaurus) recomendamos:

• npm run start para revisar la wiki en local
• npm run lint para monitorear errores de formato
• npm run lint:fix para intentar reparar errores automáticamente
• npm run build para asegurarte que todo sigue funcionando, especialmente si hiciste un cambio en la estructura de carpetas
• Instalar extensiones que te asistan en el correcto formato de MarkDown en tu IDE. En VSCode, recomendamos markdownlint
• Si se deja un bloque de código que no alude al lenguaje va a fallar el linter
• Se debe usar una versión de node igual o superior a 16, chequea que sea así escribiendo en la consola:

nvm use 16