Walkthrough

This update introduces a comprehensive, visually distinct, and interactive changelog system to the documentation site. It migrates changelog entries from a monolithic markdown file into individual files with structured metadata, adds scripts for migration, validation, and sidebar generation, implements custom React components for changelog display, and applies extensive scoped styling and timeline navigation.

Changes

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocsSite
    participant ChangelogComponents
    participant Scripts
    participant DataFiles

    User->>DocsSite: Navigates to /changelog or legacy /docs/changelog#anchor
    DocsSite->>ChangelogComponents: Renders ChangelogRedirect (if legacy URL)
    ChangelogComponents->>DataFiles: Looks up redirect mapping
    ChangelogComponents->>DocsSite: Redirects to new /changelog/:slug
    DocsSite->>ChangelogComponents: Renders ChangelogItem, Hero, Timeline, etc.
    ChangelogComponents->>DataFiles: Loads changelog entries (JSON)
    ChangelogComponents->>User: Displays changelog entry, navigation, timeline, etc.

    Note over Scripts,DataFiles: On build: Scripts generate changelog data, sidebar, and redirects from markdown files

Estimated code review effort

🎯 5 (Critical) | ⏱️ ~70 minutes

Possibly related PRs

• update changelog with code guideline #422: This PR updates code guideline scanning to include CLAUDE.md and other config files, directly relating to the addition and documentation of CLAUDE.md and the changelog system's expanded scanning capabilities.

Poem

Changelogs now sparkle, a timeline anew,
With heroics, sidebars, and tabs in full view.
Cards glide, dots pulse, as stories unfold,
Each update a chapter in colors so bold.
Scripts and styles join the lively parade—
Reviewers, rejoice! A changelog upgrade.
🚀✨

Pre-Merge Checks (3 warnings)

• 📝 Generate Docstrings

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.