Changelog

Publish product updates, release notes, and important changes in a readable timeline.

Usage

Use Changelog as the timeline container and add one ChangelogEntry for each release. Entries accept a date, title, optional version, and optional status.

  1. Independent MDX content engine

    v1.2.0new

    Gridlines now owns its complete content pipeline while preserving the same authoring experience.

    • Added automatic page-tree generation.
    • Added frontmatter status badges.
    • Added automatic blog image discovery.
  2. Better technical writing components

    v1.1.0improved

    Code blocks, file trees, API references, and tabbed examples now share one consistent visual system.

  3. Sidebar navigation fix

    v1.0.1fixed

    Fixed active navigation items becoming difficult to find in long documentation sections.

<Changelog>
  <ChangelogEntry
    date="2026-07-12"
    title="Independent MDX content engine"
    version="v1.2.0"
    status="new"
  >
    Gridlines now owns its complete content pipeline.
 
    - Added automatic page-tree generation.
    - Added frontmatter status badges.
  </ChangelogEntry>
</Changelog>

Status

Use a status when the kind of change helps readers understand the release at a glance.

StatusIntent
newA new feature or capability.
improvedAn enhancement to existing behavior.
fixedA bug fix or reliability improvement.
breakingA change that may require migration.

The status is optional. Leave it out when a version contains several kinds of changes or does not need extra emphasis.

Writing useful entries

  • Lead with the outcome instead of the implementation detail.
  • Keep one release per entry.
  • Use lists when a release contains several related changes.
  • Add migration instructions directly inside a breaking entry.
  • Keep dates in YYYY-MM-DD format so the rendered date stays predictable.

Keep the newest release first

Changelog entries render in source order. Put the latest release at the top so readers can find recent changes immediately.

Was this page helpful?