Skip to content

Migrate changelog into the docs site#3447

Draft
m-hulbert wants to merge 7 commits into
mainfrom
changelog-migration
Draft

Migrate changelog into the docs site#3447
m-hulbert wants to merge 7 commits into
mainfrom
changelog-migration

Conversation

@m-hulbert

Copy link
Copy Markdown
Contributor

Description

This PR attempts to migrate the changelog (found at changelog.ably.com) into the docs repo:

  • Creates an index page ordered by date, with a reduced set of tags to filter content on.
  • Individual articles can use the full suite of MDX components that other content can.
  • Generates an RSS feed of the latest 20 changelog entries.
  • Updates the docs homepage to read from its own changelog, rather than querying the RSS feed, removing associated Gatsby modules.
  • Adds the 5 latest changelog entries for testing purposes.

Checklist

@m-hulbert m-hulbert self-assigned this Jun 26, 2026
@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 3a52a69c-1875-4d26-b9b6-5a97e0799f17

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch changelog-migration

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

m-hulbert and others added 7 commits June 26, 2026 11:56
Pure data layer for the in-repo changelog: entry types, file-node mapping,
product tags, date formatting (UTC-stable), product filtering/sorting, and URL
absolutization, with unit tests.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add changelog frontmatter fields to the MDX schema, route changelog MDX to a
dedicated entry template (no product left-nav, constrained reading width), and
render the entry header, OG image, and a data-changelog-body marker. Extend Head
with OG image and RSS link support.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Filterable, client-paginated timeline of changelog entries: a product filter
rail synced to the URL, a month-grouped timeline with Show more pagination, and
entry cards. Includes behavioural tests for pagination and filtering.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Build an RSS 2.0 feed from the changelog MDX at onPostBuild, with full entry
content extracted from each built page (data-changelog-body). Validate product
slugs and assert content coverage so a broken contract fails the build. A guard
test keeps the duplicated GraphQL scope literal in sync across queries.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a Changelog header nav link, point the footer link at the in-repo
/docs/changelog, and rewrite the homepage changelog widget to source entries
from the in-repo MDX instead of the external feed.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Remove the gatsby-source-rss-feed plugin and dependency now that the homepage
and changelog source entries from the in-repo MDX.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Seed the in-repo changelog with the first five entries (June 2026): JS SDK
2.22.1 and 2.23.0, AI Transport JS SDK 0.2.0 and 0.3.0, and improved LiveObjects
visibility.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@m-hulbert m-hulbert force-pushed the changelog-migration branch from 649ff3e to 952b51a Compare June 26, 2026 10:57
@m-hulbert m-hulbert added review-app Create a Heroku review app and removed review-app Create a Heroku review app labels Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

1 participant