[WEB-4086] Showcase examples via Sandpack

[jamiehenson]

Previously, we introduced an index page for examples with filtering. In this PR, we hook those cards up to pages showcasing the described examples. This is using Sandpack, a sandboxed Node environment we have used for the Pubsub how to page. Housing Sandpack is a template that contains a Sandpack renderer, a rendered Markdown README content for each example, and other useful design elements.

Word of bot

This pull request includes extensive changes to the data/createPages/index.ts file to integrate examples into the page creation process, updates to the gatsby-config.ts file to add a new source for examples, modifications to several components to support the new examples, and updates to test files to reflect these changes.

Integration of Examples into Page Creation

• data/createPages/index.ts: Added imports for examples and their types, defined a new ExampleQueryResult interface, and included a GraphQL query to fetch example files. Implemented a new exampleCreator function to create pages for each example. [1] [2] [3] [4] [5]

Configuration Updates

• gatsby-config.ts: Added a new gatsby-source-filesystem plugin configuration to source example files from the examples directory.

Component Modifications

• src/components/CodeEditor/Chrome.tsx and src/components/CodeEditor/CodeEditor.tsx: Introduced a theme prop to support both light and dark themes. [1] [2]
• src/components/Examples/ExamplesContent.tsx: Updated imports and state initialization to use the new examples data structure. [1] [2] [3] [4]
• src/components/Examples/ExamplesFilter.tsx: Modified to use the new useCases import from examples data. [1] [2]
• src/components/Examples/ExamplesGrid.tsx: Updated to use the new examples data structure and improved image handling logic. [1] [2] [3]

Test Updates

• src/components/Examples/ExamplesContent.test.tsx: Adjusted tests to reflect the new examples data structure and fixed capitalization in test strings. [1] [2] [3] [4]

[coderabbitai]

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.

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

---

🪧 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 plan to trigger planning for file edits and PR creation.
• @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.