Add realtime / react hooks examples snippet

[D-K-P]

Summary by CodeRabbit

• Documentation Enhancements
  • Introduced a dynamic component showcasing real-time API examples across multiple documentation pages.
  • Added curated examples, including image generation, CSV importing, language model evaluation, and interactive chatbots.
  • Enhanced resource sections with links to guides and repositories for practical implementations.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 828334f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

This pull request updates several documentation files by adding an import for and the usage of the <RealtimeExamplesCards /> component. The component is integrated into multiple MDX files under the frontend and realtime directories. Additionally, a new snippet file is added that defines example cards using CardGroup and Card components to showcase real-time API use cases. No existing content is removed or altered aside from the addition of these components.

Changes

File(s)	Change Summary
docs/frontend/react-hooks/overview.mdx, docs/frontend/react-hooks/realtime.mdx, docs/frontend/react-hooks/triggering.mdx	Added import statement for RealtimeExamplesCards and appended <RealtimeExamplesCards /> at the end of each document.
docs/realtime/overview.mdx, docs/realtime/streams.mdx	Introduced import of RealtimeExamplesCards and appended <RealtimeExamplesCards /> (with minor formatting adjustments in overview.mdx).
docs/snippets/realtime-examples-cards.mdx	Created a new section defining CardGroup and Card components to display examples of projects using the Realtime API, along with a "Learn more" resource section.

Possibly related PRs

• Added LLM evaluator to example projects #1589: The changes in this PR and the retrieved PR are related as both introduce the <RealtimeExamplesCards /> component and its import statement in different documentation files.
• Added supabase database operations and new snippet #1359: The changes in this PR and the retrieved PR are related as both introduce the <RealtimeExamplesCards /> component in different documentation files, indicating a shared focus on real-time functionalities.
• Adding example projects #1564: The changes in this PR and the retrieved PR are related as both introduce the <RealtimeExamplesCards /> component and its import statement in different documentation files.

Suggested reviewers

• samejr

Poem

I’m a happy rabbit, hopping here and there,
In docs I’ve found a shiny new component to share,
Realtime examples pop like carrots in the sun,
With <RealtimeExamplesCards />, learning’s fun,
I nibble on code and in proofs I delight,
A leap of documentation makes everything bright!
🥕🐇

---

🪧 Tips

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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/snippets/realtime-examples-cards.mdx (2)

3-37: Well-Structured Examples Group:
The first <CardGroup> block is well-organized. Each <Card> provides a clear title, icon, and link accompanied by descriptive text.
Minor Suggestion: Consider capitalizing "react hooks" as "React hooks" for consistency with common naming conventions.

---

55-55: Remove Stray Content:
The trailing "55" appears to be an extraneous artifact. If unintentional, please remove it to maintain clean formatting.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 828334f and d901850.

📒 Files selected for processing (1)

• docs/snippets/realtime-examples-cards.mdx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (3)

docs/snippets/realtime-examples-cards.mdx (3)

1-2: Clear Section Header:
The "## Examples" header clearly introduces the examples section.

---

39-40: Informative Sub-header:
The "### Learn more" sub-header effectively transitions the reader to additional resources.

---

41-54: Solid "Learn More" Section:
The second <CardGroup> is effective in guiding users to further documentation and the GitHub repository. The descriptions are concise and helpful.