Correct Hive Gateway Next.js example

[enisdenjo]

Fixes #6453

Examples should be copy-pasteable and not include changes that don't work or lack context.

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Updated the Next.js integration guide with enhanced details on custom routing.
  • Revised usage examples and configuration instructions to reflect the latest guidance, ensuring clearer direction for setup.

Summary by CodeRabbit

• Documentation
  • Updated the Next.js integration guide with clearer instructions.
  • Revised the example section to highlight the importance of reviewing the complete documentation.
  • Enhanced the custom route handling description for improved user guidance.

Walkthrough

The documentation for Hive Gateway integration with Next.js has been updated. The initial description has been retained but expanded to include a reference to a custom route handler. The example section has been significantly altered, replacing previous comments with a directive to consult the relevant documentation. Additionally, a new import statement for supergraph has been added, and the configuration settings related to fetchAPI have been removed. The supergraph is now included in the createGatewayRuntime function call, while the export statement for the handler remains unchanged.

Changes

File	Change Summary
packages/web/docs/src/.../nextjs.mdx	Retained and expanded the initial description; updated to reference a custom route handler; revised example section by adding an import for supergraph, removing fetchAPI configuration, while keeping the export statement unchanged.

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 66a8bb3 and d660653.

📒 Files selected for processing (1)

• packages/web/docs/src/content/gateway/deployment/node-frameworks/nextjs.mdx (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/web/docs/src/content/gateway/deployment/node-frameworks/nextjs.mdx

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

• GitHub Check: test / unit
• GitHub Check: build / dockerize (linux/arm64)
• GitHub Check: typescript / typecheck
• GitHub Check: build / dockerize (linux/amd64)
• GitHub Check: static-analysis / analyze (typescript)
• GitHub Check: static-analysis / analyze (javascript)
• GitHub Check: alpha / cli-artifacts
• GitHub Check: code-style / eslint-and-prettier

---

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

packages/web/docs/src/content/gateway/deployment/node-frameworks/nextjs.mdx (2)

17-17: Improve Link Formatting for Clarity
The directive now clearly instructs users to review the Next.js router handlers documentation. For enhanced usability and to ensure the link is clickable when copy-pasting, consider formatting it as a proper Markdown link, for example:

Please read the [Next.js Router Handlers documentation](https://nextjs.org/docs/app/building-your-application/routing/router-handlers) first.

---

19-29: Enhance Code Snippet Completeness
The updated code snippet now includes the import for supergraph, which makes the example more self-contained and copy-pasteable. Ensure that the referenced file (./my-supergraph) is either included in the repository or clearly marked as a placeholder in the documentation. This will help prevent confusion for developers who might otherwise look for an actual implementation.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 05c292c and 66a8bb3.

📒 Files selected for processing (1)

• packages/web/docs/src/content/gateway/deployment/node-frameworks/nextjs.mdx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`packages/web/docs/**`: The main landing page and documentat...

packages/web/docs/**: The main landing page and documentation website. It's built using TypeScript, Tailwind, NextJS and Nextra.

In PRs that adds a new feature to the product, we would like to make sure that the PR includes the following:

• Up to date documentation in packages/web/docs/src/content
• A product update in packages/web/docs/src/app/product-updates

• packages/web/docs/src/content/gateway/deployment/node-frameworks/nextjs.mdx

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

• GitHub Check: alpha / cli-artifacts
• GitHub Check: test / unit
• GitHub Check: static-analysis / analyze (typescript)
• GitHub Check: typescript / typecheck
• GitHub Check: code-style / eslint-and-prettier
• GitHub Check: static-analysis / analyze (javascript)
• GitHub Check: build / dockerize (linux/arm64)
• GitHub Check: validate-mdx-links / validate-mdx-links
• GitHub Check: build / dockerize (linux/amd64)