Skip to content

Commit 6b2ec87

Browse files
committed
doc:actualiza la estructura que utiliza el planemiento.json
1 parent d8e2b75 commit 6b2ec87

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,16 @@ Global course information that feeds both the application Header/Footer and MyST
116116
* `title`, `semester`, `university`, `description`
117117
* `authors`: List of authors.
118118

119+
#### Config (Optional)
120+
Configuration settings for the application:
121+
* `unitLabel`: Custom label for the time unit (e.g., "Week", "Session", "Module").
122+
119123
#### Weeks
120124
Each entry in the `weeks` array represents a week of classes and contains:
121125

122126
* `week`: Sequential week number.
127+
* `title`: Main title of the session.
128+
* `subtitle`: Optional subtitle or topic description.
123129
* `content`: List of topics to cover.
124130
* `objectives`: Specific learning objectives.
125131
* `activities`: Description of dynamic activities (labs, workshops).
@@ -129,6 +135,8 @@ Each entry in the `weeks` array represents a week of classes and contains:
129135
```json
130136
{
131137
"week": 1,
138+
"title": "Introduction to Physics",
139+
"subtitle": "Fundamental Concepts",
132140
"content": [
133141
"Units and unit conversion",
134142
"SI units",

README_es.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,16 @@ Información global del curso que alimenta tanto al Header/Footer de la aplicaci
115115
* `title`, `semester`, `university`, `description`
116116
* `authors`: Lista de autores.
117117

118+
#### Config (Opcional)
119+
Configuración general de la aplicación:
120+
* `unitLabel`: Etiqueta personalizada para la unidad de tiempo (ej., "Semana", "Sesión", "Módulo").
121+
118122
#### Weeks
119123
Cada entrada en el array `weeks` representa una semana de clases y contiene:
120124

121125
* `week`: Número secuencial de la semana.
126+
* `title`: Título principal de la sesión.
127+
* `subtitle`: Subtítulo o descripción del tema (opcional).
122128
* `content`: Lista de temas a cubrir.
123129
* `objectives`: Objetivos de aprendizaje específicos.
124130
* `activities`: Descripción de actividades dinámicas (laboratorios, talleres).
@@ -128,6 +134,8 @@ Cada entrada en el array `weeks` representa una semana de clases y contiene:
128134
```json
129135
{
130136
"week": 1,
137+
"title": "Introducción a la Física",
138+
"subtitle": "Conceptos Fundamentales",
131139
"content": [
132140
"Unidades y conversión de unidades",
133141
"unidades del SI",

0 commit comments

Comments
 (0)