Migrate changelog into the docs site#3447
Draft
m-hulbert wants to merge 8 commits into
Draft
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
m-hulbert
force-pushed
the
changelog-migration
branch
from
649ff3e to
952b51a
Compare
m-hulbert
added
review-app
Pure data layer for the in-repo changelog: entry types, file-node mapping, product tags, UTC-stable date formatting, and product filtering/sorting (with a deterministic slug tiebreak so same-day entries are stable across builds), plus URL absolutization. Unit-tested. 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 and OG image. Extend Head with OG image and RSS link support. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Single-column changelog index: an RSS button beside the title, product-filter lozenges, and a reverse-chronological list showing each entry's full date in a left column, separated by rules, with Show more pagination. Filtering syncs to the ?product= query string. Includes behavioural tests for pagination and filtering. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Build a summary RSS 2.0 feed (title, meta_description blurb, link, pubDate, and a category per product) from the changelog MDX at onPostBuild, via a pure, unit-tested buildFeedXml. Validate product slugs so a typo fails the build, and 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>
Seven dummy "ice cream" changelog entries (May 2026) used ONLY to exercise the index locally — MDX component rendering, the product filter, Show more pagination, and the RSS feed. These are not real product updates and should be removed before launch. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
m-hulbert
force-pushed
the
changelog-migration
branch
from
952b51a to
3570977
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR attempts to migrate the changelog (found at changelog.ably.com) into the docs repo:
Checklist