docs(router): plugin system

[ardatan]

Documentation of graphql-hive/router#482

[gemini-code-assist]

Summary of Changes

Hello @ardatan, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the documentation for the Hive Router by introducing detailed guides and API references for its plugin system. The changes aim to empower developers to extend the router's functionality with custom Rust plugins, providing clear instructions on implementation, configuration, and deployment. This makes the router more flexible and adaptable to diverse use cases.

Highlights

• New Plugin System Documentation: Introduced a comprehensive documentation page detailing the Hive Router's plugin system, covering its API, various lifecycle and request hooks, configuration, shared state, and context data sharing.
• New Guide for Extending the Router: Added a step-by-step guide on how to extend the Hive Router by creating, registering, and deploying custom Rust plugins, including examples for main entrypoint, plugin implementation, and Dockerization.
• Documentation Navigation Updates: Updated the router documentation's navigation structure to include new 'Extensibility' and 'Extending the Router' sections, making the new content easily discoverable.
• New Router Hook Section Component: Created a reusable React component, RouterHookSection, to standardize the presentation of plugin hook documentation within the new pages.

Changelog

• packages/web/docs/src/content/router/_meta.ts
  • Added 'Extensibility' entry to the router's main navigation metadata.
• packages/web/docs/src/content/router/guides/_meta.ts
  • Added 'Extending the Router' entry to the router's guides navigation metadata.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

🚀 Snapshot Release (alpha)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package	Version	Info
@graphql-hive/apollo	0.48.0-alpha-20260305084943-905781016d91124746a6e57452899e83173daf56	npm ↗︎ unpkg ↗︎
@graphql-hive/cli	0.58.4-alpha-20260305084943-905781016d91124746a6e57452899e83173daf56	npm ↗︎ unpkg ↗︎
@graphql-hive/core	0.21.0-alpha-20260305084943-905781016d91124746a6e57452899e83173daf56	npm ↗︎ unpkg ↗︎
@graphql-hive/envelop	0.40.5-alpha-20260305084943-905781016d91124746a6e57452899e83173daf56	npm ↗︎ unpkg ↗︎
@graphql-hive/yoga	0.48.0-alpha-20260305084943-905781016d91124746a6e57452899e83173daf56	npm ↗︎ unpkg ↗︎
hive	9.6.0-alpha-20260305084943-905781016d91124746a6e57452899e83173daf56	npm ↗︎ unpkg ↗︎

[github-actions]

🐋 This PR was built and pushed to the following Docker images:

Targets: build

Platforms: linux/amd64

Image Tag: 905781016d91124746a6e57452899e83173daf56

[gemini-code-assist]

Code Review

This pull request adds extensive documentation for the new router plugin system, including a detailed API reference and a step-by-step guide for creating custom plugins. The documentation is comprehensive and well-structured. I've found a few minor issues in the code examples and some opportunities to improve the guide, which are detailed in my comments.

[github-actions]

💻 Website Preview

The latest changes are available as preview in: https://pr-7743.hive-landing-page.pages.dev

[enisdenjo]

The page has a height of 25000px, I think it'd be easier to navigate if the plugin system were split into multiple pages. Especially easier to navigate because you would see all of the core concepts on the left sidebar without being on the page.