Adding Subgraph Gateway Docs v1.0 - #1117
Open
brandonleekramer wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add Subgraph Gateway docs module (Gateway Software section)
Summary
Adds a new top-level Gateway Software section to the docs, documenting how to operate a Subgraph Gateway on The Graph Network. The content covers what a Gateway does, how it fits into The Graph, and the full set of consumer-side and supply-side responsibilities of running one — ~20k words across 21 pages, migrated from the
graph-gtm-kitdrafts and adapted to the docs site's conventions (.mdx+ frontmatter, absolute trailing-slash links, Nextra_metaordering).The top level is intentionally a container (
gateways/) rather than the product itself, so additional gateway offerings can be added alongside Subgraph Gateway later without another restructure.Structure
What's included
.mdx), each with proper frontmatter (title, plussidebarTitlewhere the sidebar label differs from the page title)._meta.js/_meta-titles.jsonfiles controlling section order and sidebar labels. Ordering follows the documentation's own "how this is organized" flow (Overview → Components → Consumer-Side → Supply-Side → Ecosystem).website/public/img/gateway/: the Gateway architecture and Kafka-topics diagrams (.png+.svg) plus the Subgraph Gateway logo assets used for the nav icon.Navigation & integration changes
website/next.config.js— registeredgatewaysas a top-level nav entry ("Gateway Software"), placed between Indexer Software and Data Services.website/src/layout/Layout.tsx— added the sidebar icon for/gateways, rendered from the Subgraph Gateway logo as acurrentColormask so it themes and highlights like the other GDS nav icons, sized to match them.website/src/pages/en/global.json— renamed the "Indexing" nav label to "Indexer Software".Notable decisions
components/usesoverview(labeled "Technical Overview") as its landing page rather than a separate index page.components/overview→ "Technical Overview",supply-side/routing-queries→ "Routing Queries",consumer-side/serving-queries→ "Serving Queries",consumer-side/pricing-payments→ "Pricing & Payments").Verification
prettier --checkclean across all touched files.eslint --max-warnings 0clean on all changed JS/TS (Layout.tsx,next.config.js,_meta.jsfiles).pnpm dev): section appears in the sidebar with the correct order, labels, icon, and working diagrams.Notes for reviewers