Anatomía de un tópico

Dentro de cada carpeta de tópico debe haber un archivo README.md con la información general del tópico.

Estructura de archivos:

00-topic-slug
├── 01-unit-slug
│   ├── 00-opening
│   │   └── README.md
│   ├── 01-part-title-1
│   │   └── README.md
│   ├── 02-part-title-2
│   │   └── README.md
│   ├── 03-example-exercise
│   │   ├── 01-print-primes
│   │   │   ├── README.md
│   │   │   ├── boilerplate
│   │   │   │   └── printPrimes.js
│   │   │   ├── solution
│   │   │   │   └── printPrimes.js
│   │   │   └── test
│   │   │       └── printPrimes.spec.js
│   │   └── README.md
│   └── 04-closing
│       └── README.md
├── 02-unit-slug/
│   └── ...
├── 03-unit-slug/
│   └── ...
└── README.md

Nombres de archivos y carpetas en minúsculas, usando - en vez de espacios y evitando caracteres especiales.

README.md principal del tópico

Cada tópico empieza por un archivo README.md. La mejor manera de familiarizarse con la estructura de este archivo es ver este ejemplo.

• Título (title)
• Descripción (description)
• Tags: (tags)

Secciones:

• Público objetivo (targetAudience)
• Requerimientos previos (dependencies)
• Objetivos de aprendizaje (learningObjectives)
• Producto(s) a desarrollar (product)
• Guía de preguntas y conceptos clave (keyConcepts)
• Syllabus (syllabus)
• Evaluación (grading)
• Contribuidores (contributors)
• Libros (books)
• Benchmarks (benchmarks)
• Referencias (references)

Título (requerido)

La primera línea del README.md de un tópico debe contener un h1 con el título completo.

# Título del tópico

Descripción (requerido)

La descripcción del tópico es un espacio libre que va desde el título hasta la lista de tags o el heading de público objetivo.

Tags (requerido)

...

Tags secundarios (opcional)

Público objetivo (requerido)

Requerimientos previos (requerido)

Objetivos de aprendizaje (requerido)

Producto(s) (requerido)

Guía de preguntas y conceptos clave (opcional)

Syllabus (requerido)

Evaluación (requerido)

Contribuidores (requerido)

Libros (opcional)

Benchmarks (opcional)

Referencias (opcional)