Skip to content

[FEATURE] Actualización de jerarquía de encabezados #22

@arcamoon

Description

@arcamoon

🔍 Verificaciones previas

  • Busqué issues existentes y no encontré uno similar

🧩 Tipo de mejora

  • 🛠️ Desarrollo - nueva funcionalidad o cambio en el código
  • 📄 Documentación - mejorar el README, guías, comentarios en código o ejemplos
  • ♿ Accesibilidad - mejorar la experiencia para personas con discapacidad
  • ⚡ Rendimiento - optimización de velocidad, uso de memoria o recursos
  • 🎨 UI / UX - cambios en la interfaz o experiencia de usuario
  • 🧪 Testing - agregar o mejorar pruebas automatizadas
  • 🔧 Infraestructura / DevOps - CI/CD, despliegue, configuración de entornos
  • 📚 Contenido - mejoras o correcciones en el contenido, como blogs, tutoriales o recursos educativos

✨ Descripción de la propuesta

Actualmente no se considera una estructura de encabezados en el PSG.

🎯 Problema que resuelve

No contar con una estructura de encabezados dificulta la aplicación de estilos que permitan crear un lenguaje visual en el contenido educativo.

👤 Caso de uso

Como usuario que quiere aprender Python accederé al recurso en cuestión y gracias a la jerarquía de encabezados y los estilos aplicados, sabré implícitamente que subconceptos engloba un concepto, cuando se realiza un cambio de subtítulo, optimizando mi proceso de aprendizaje.

💡 Solución propuesta

Se debe acceder al contenido de índices de cada módulo, revisarlos y crear su jerarquía de encabezados, posteriormente realizar las correcciónes respectivas a nivel de código.
Posterior a ello, se procedería con la aplicación de estilos para generar lenguaje visual en el contenido.

🚀 Impacto esperado

  • Beneficia al usuario, pues permitirá el uso de lenguaje visual que facilite su aprendizaje y navegación entre los distintos temas, subtemas, conceptos, listados del recurso.
  • Beneficia a la comunidad en si, ya que permitirá recalcar que nuestro contenido se encuentra correctamente estructurado.

🔍 Alternativas consideradas

Otra alternativa a considerar sería mantener los encabezados como se encuentran actualmente, y aplicar los estilos usandos clases o identificadores, sin embargo esto mantendría una deuda técnica que será comentada por futuros mantenedores del repositorio.

✅ Criterios de aceptación

  • Existe un archivo de una jerarquía de encabezados del contenido, y el código .md sigue esta jerarquía al pie de la letra.

🤝 ¿Te gustaría contribuir con esto?

Por ahora solo propongo la idea

📎 Recursos adicionales

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions