Nuevo
Utilidades, módulos o páginas agregadas al sistema.
Changelog
Changelog documenta la evolución del framework: cambios estructurales, nuevas utilidades, correcciones y decisiones de mantenimiento del sistema.
Qué resuelve changelog
Un framework vivo necesita historial. Changelog permite registrar cambios de forma clara, entender qué se modificó entre versiones y evitar que decisiones importantes se pierdan.
No solo documenta nuevos helpers. También sirve para dejar constancia de ajustes de naming, reordenamientos internos, reglas de mantenimiento y mejoras de consistencia.
Estructura recomendada de cada entrada
- Versión → número o etiqueta de release.
- Fecha → momento del cambio.
- Tipo → Added, Changed, Fixed, Removed, Deprecated.
- Resumen → qué cambió en términos claros.
- Impacto → qué módulos o páginas afecta.
- Notas → decisiones importantes o advertencias de migración.
Tipos de cambios
Modificado
Ajustes a comportamiento, naming o estructura existente.
Corregido
Errores resueltos o inconsistencias alineadas con la arquitectura.
Eliminado
Helpers o decisiones retiradas del sistema.
Desaconsejado
Elementos aún presentes pero que deberían dejar de usarse.
Ejemplo de formato
<article class="docs-changelog-entry stack stack-md">
<div class="align justify-between items-center gap-2 wrap">
<div class="stack stack-xs">
<p class="meta ls-sm">Version 1.0.0</p>
<h3 class="title docs-card-title fnt-uppercase">Initial framework release</h3>
</div>
<p class="meta ls-sm">April 2026</p>
</div>
<ul class="list list-stack list-stack-md">
<li><strong>Added:</strong> Base, layout, spacing, align, typography and documentation pages.</li>
<li><strong>Changed:</strong> Import order in framework core.</li>
<li><strong>Fixed:</strong> Consistency in stack responsive variants.</li>
</ul>
</article>Ejemplo de historial
Initial framework foundation
- Added: Base architecture, layout, rhythm, helpers and motion system.
- Added: Initial documentation structure with index, docs and architecture pages.
- Changed: Unified naming around mobile-first conventions.
Documentation expansion
- Added: Dedicated pages for containers, grid, proportions, sections, stack and spacing.
- Added: Guidelines, naming conventions and changelog pages.
- Fixed: Clarified separation between section, stack and spacing responsibilities.
Consistency fixes
- Fixed: Improved documentation consistency for helper boundaries.
- Changed: Refined descriptions of visibility and align modules.
- Deprecated: Arbitrary additions outside documented file responsibilities.
Qué vale la pena registrar
Sí registrar
- Nuevos módulos o helpers.
- Cambios en naming.
- Reordenamiento de layers o imports.
- Correcciones de comportamiento sistémico.
- Deprecaciones y eliminaciones.
No saturar con
- Ajustes mínimos irrelevantes.
- Cambios puramente de contenido editorial de una página.
- Notas de proyecto que no afectan al framework.
- Correcciones visuales locales fuera del sistema.
Buenas prácticas
- Usa un orden consistente en cada entrada: Added, Changed, Fixed, Removed, Deprecated.
- Escribe cada cambio de forma breve y verificable.
- No mezcles cambios del framework con cambios del sitio que lo usa.
- Documenta la razón de un cambio si afecta decisiones futuras.
- Si un helper cambia de lugar o nombre, déjalo explícito.
Cierre del sistema base
Con changelog queda cerrada la documentación principal del framework base. A partir de aquí, el siguiente paso natural es construir páginas de patterns o ejemplos aplicados.