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.
Independent MDX content engine
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.
Better technical writing components
Code blocks, file trees, API references, and tabbed examples now share one consistent visual system.
Sidebar navigation fix
Fixed active navigation items becoming difficult to find in long documentation sections.
Status
Use a status when the kind of change helps readers understand the release at a glance.
| Status | Intent |
|---|---|
new | A new feature or capability. |
improved | An enhancement to existing behavior. |
fixed | A bug fix or reliability improvement. |
breaking | A 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
breakingentry. - Keep dates in
YYYY-MM-DDformat 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.