Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThis change implements a major redesign of the documentation homepage. It removes the previous generic, card-based section layout and introduces a new, more structured homepage composed of distinct sections: a hero header, a platform and products showcase, an examples section, and a dynamically populated changelog feed. The homepage content structure and associated types are refactored to support this new layout. Several obsolete components are deleted, and new components are added for the redesigned sections. Additionally, the changelog feed is sourced via a new RSS plugin, with supporting code and dependencies introduced for RSS feed integration. Sidebar layout options are also updated for greater granularity. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Homepage
participant PlatformAndProducts
participant ExamplesSection
participant ChangelogSection
participant GatsbyStaticQuery
User->>Homepage: Visit docs homepage
Homepage->>HeroSection: Render hero header
Homepage->>PlatformAndProducts: Render platform/products section
Homepage->>ExamplesSection: Render examples section
Homepage->>ChangelogSection: Render changelog feed
ChangelogSection->>GatsbyStaticQuery: Fetch latest changelog entries from RSS
GatsbyStaticQuery-->>ChangelogSection: Return changelog data
ChangelogSection->>Homepage: Render changelog entries
Assessment against linked issues
Suggested reviewers
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
611f647 to
f73a71a
Compare
f73a71a to
854a5ed
Compare
854a5ed to
7fd1b8c
Compare
7fd1b8c to
d021685
Compare
d021685 to
e91b95f
Compare
e91b95f to
459453c
Compare
459453c to
d40055f
Compare
aralovelace
left a comment
There was a problem hiding this comment.
will check more next week
m-hulbert
left a comment
There was a problem hiding this comment.
I think we can also delete everything in src/components/Homepage/BodySection with this update.
jamiehenson
left a comment
There was a problem hiding this comment.
Pretty good, close to a stamp for me. Though naturally we can't release this until Examples goes out, which is marked for this week no matter what. Related to this, there also needs to be changes to the Header to both allow the Documentation/Examples switched, and the "DOCS" bit alongside the logo.
From testing locally:
- the headers of the Examples and Changelogs sections (incl their respective View All links) aren't aligned with eachother vertically
- in mobile, the margin between the product tiles section and the Examples section needs to be reduced to 48px from 64px
- the gap is too big between the header and the Platform & Products section
d40055f to
520cc12
Compare
520cc12 to
57fb31b
Compare
57fb31b to
acb83fd
Compare
979c2d0 to
01e4574
Compare
01e4574 to
14c0dc1
Compare
14c0dc1 to
04a4f44
Compare
04a4f44 to
2ee04eb
Compare
this will allow us to pull rss feed we can then display
this will pull from ably change log
it is no longer being used
2ee04eb to
ce96f96
Compare

See WEB-4259 New simple design to match with the updated nav, including pulling the changelog
Summary by CodeRabbit
New Features
Refactor
Chores
Removed