docs: Hono related updates

[ymc9]

Summary by CodeRabbit

• Documentation
  • Enhanced guidance on deploying ZenStack to edge runtime environments, emphasizing performance benefits and clarifying database driver requirements.
  • Expanded Cloudflare Workers section with a new example using Neon database and recommendations for using Hono as a backend framework.
  • Added a new FAQ section in the Tanstack Query plugin documentation addressing a common error in Next.js applications.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
zenstack-new-site	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 13, 2024 8:56pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request includes updates to two documentation files: docs/guides/edge.md and docs/reference/plugins/tanstack-query.mdx. The changes to edge.md enhance guidance on deploying ZenStack in edge environments, emphasizing the use of edge-compatible database drivers and providing expanded examples for Vercel Edge Runtime and Cloudflare Workers. The tanstack-query.mdx file introduces a new FAQ section that addresses a specific error in Next.js applications, along with minor formatting adjustments for clarity.

Changes

File	Change Summary
docs/guides/edge.md	Updated to clarify edge-compatible database drivers, Vercel Edge Runtime, and Cloudflare Workers. Added examples and emphasized the need for a new PrismaClient per request. Suggested using Hono as a backend framework.
docs/reference/plugins/tanstack-query.mdx	Added a new FAQ section addressing the createContext error in Next.js, including troubleshooting guidance. Minor formatting adjustments made.

Possibly related PRs

• docs: doc changes for release 2.5.0 #361: Updates to docs/guides/edge.md, enhancing clarity on deploying ZenStack in edge environments.
• docs: release 2.8.0 #381: Additional updates to docs/guides/edge.md, addressing similar topics regarding edge runtime environments.
• doc: replace swr with TanStack for next page router tutorial #337: Focuses on integrating ZenStack with Next.js, mentioning @zenstackhq/tanstack-query.
• docs: add FAQ to tanstack-query #385: Adds an FAQ section to the @zenstackhq/tanstack-query documentation, providing context for edge deployment.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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