Plan progresivo de endurecimiento de reglas de markdownlint para mejorar la calidad de Markdown en el proyecto.
Contexto
El issue #139 ya implementó markdownlint con una configuración única unificada usando severity levels. La mayoría de reglas están configuradas como warning para mantener compatibilidad con contenido existente.
Este issue se enfoca en el siguiente paso: auditar y endurecer estas reglas progresivamente, convirtiendo warnings a errors según sea justificado.
Objetivo
Reducir gradualmente el número de warnings y aumentar el número de errors, haciendo que la validación de Markdown sea más estricta de forma progresiva.
Enfoque
- Auditar reglas actuales: Identificar cuáles warnings podrían convertirse a errors
- Planificar endurecimiento por fases: Cambios incrementales, no disruptivos
- Implementar por PRs discretas: Cada cambio en una PR separada con justificación clara
- Documentar decisiones: Actualizar ADR 009 y
.markdownlint.jsonc con el razonamiento
Criterios para convertir warning → error
Una regla debería cambiar a error si:
- Mejora significativamente la calidad y consistencia de markdown
- No rompe compilación para la mayoría del contenido existente
- Es fácil de corregir automáticamente con
npm run lint:md:fix
- Tiene un propósito claro y está bien documentado en comentarios JSONC
Tareas
Notas
- Este issue no es urgente: es trabajo de mejora continua
- Priorizar reglas que afecten legibilidad general (p.ej. espacios alrededor de encabezados)
- Mantener compatibilidad con contenido generado automáticamente (p.ej. licenses, markdown generado)
- Referencia: ADR 009 — Validación de Markdown
Relacionado: Issue #139 (implementación inicial de markdownlint)
Plan progresivo de endurecimiento de reglas de
markdownlintpara mejorar la calidad de Markdown en el proyecto.Contexto
El issue #139 ya implementó
markdownlintcon una configuración única unificada usando severity levels. La mayoría de reglas están configuradas comowarningpara mantener compatibilidad con contenido existente.Este issue se enfoca en el siguiente paso: auditar y endurecer estas reglas progresivamente, convirtiendo warnings a errors según sea justificado.
Objetivo
Reducir gradualmente el número de warnings y aumentar el número de errors, haciendo que la validación de Markdown sea más estricta de forma progresiva.
Enfoque
.markdownlint.jsonccon el razonamientoCriterios para convertir warning → error
Una regla debería cambiar a error si:
npm run lint:md:fixTareas
.markdownlint.jsoncNotas
Relacionado: Issue #139 (implementación inicial de markdownlint)