Skip to content

docs: curate CHANGELOG.md for v3.0.0 release #1530

@SchoolyB

Description

@SchoolyB

Summary

The current CHANGELOG.md is auto-generated by a workflow and will contain ~1,000+ commit entries spanning the v2.0 to v3.0.0 development cycle. This is too noisy to be useful — especially since the webapp fetches and displays this file directly.

Action Items

Before shipping v3.0.0:

  1. Replace the auto-generated v3.0.0 entries with a curated summary grouped by category:

    • Breaking changes
    • New features (compiler rewrite, wide integers, etc.)
    • Standard library additions/changes
    • Bug fixes (highlight major ones)
    • Removed/deprecated features
  2. Keep the auto-generation workflow active for future point releases (v3.0.1, v3.1.0) where commit volume will be manageable per release.

  3. Optionally archive the raw v2.x changelog content to a separate file if it adds too much length.

Context

  • The EZ webapp fetches CHANGELOG.md and renders it on the site
  • The file is currently 1,476 lines and growing
  • A curated summary is far more useful to users than 1,000 individual commit lines

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions