Skip to content

Adding Subgraph Gateway Docs v1.0 - #1117

Open
brandonleekramer wants to merge 1 commit into
mainfrom
gateway-docs-v1
Open

Adding Subgraph Gateway Docs v1.0#1117
brandonleekramer wants to merge 1 commit into
mainfrom
gateway-docs-v1

Conversation

@brandonleekramer

Copy link
Copy Markdown
Member

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-kit drafts and adapted to the docs site's conventions (.mdx + frontmatter, absolute trailing-slash links, Nextra _meta ordering).

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

en/gateways/                         → "Gateway Software" (new top-level nav section)
└─ subgraphs/                        → "Subgraph Gateway"
   ├─ overview
   ├─ components/                    → "Gateway Components"
   │  ├─ overview                    (sidebar: "Technical Overview")
   │  ├─ operating-a-gateway
   │  ├─ indexer-selection           (sidebar: "Indexer Selection")
   │  ├─ graph-tally
   │  ├─ titorelli
   │  └─ gateway-in-a-box
   ├─ consumer-side/                 → "Consumer-Side"
   │  ├─ overview
   │  ├─ pricing-payments            (sidebar: "Pricing & Payments")
   │  ├─ serving-queries             (sidebar: "Serving Queries")
   │  ├─ subgraph-collections
   │  ├─ publication-flows           (sidebar: "Publication Flows")
   │  ├─ customer-support
   │  └─ indexing-approaches         (sidebar: "Indexing Approaches")
   ├─ supply-side/                   → "Supply-Side"
   │  ├─ overview
   │  ├─ routing-queries             (sidebar: "Routing Queries")
   │  ├─ managing-escrow
   │  ├─ incentivizing-syncs
   │  └─ tracking-qos
   └─ ecosystem/                     → "Ecosystem Contributions"
      ├─ graph-node
      └─ chain-integrations

What's included

  • 21 content pages (.mdx), each with proper frontmatter (title, plus sidebarTitle where the sidebar label differs from the page title).
  • 8 _meta.js / _meta-titles.json files controlling section order and sidebar labels. Ordering follows the documentation's own "how this is organized" flow (Overview → Components → Consumer-Side → Supply-Side → Ecosystem).
  • Diagrams & assets in website/public/img/gateway/: the Gateway architecture and Kafka-topics diagrams (.png + .svg) plus the Subgraph Gateway logo assets used for the nav icon.
  • All internal links rewritten to the site convention (absolute path from root, no file extension, trailing slash), and validated to resolve.

Navigation & integration changes

  • website/next.config.js — registered gateways as 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 a currentColor mask 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/ uses overview (labeled "Technical Overview") as its landing page rather than a separate index page.
  • Several files/URLs were shortened for cleaner paths while keeping their display titles (e.g. components/overview → "Technical Overview", supply-side/routing-queries → "Routing Queries", consumer-side/serving-queries → "Serving Queries", consumer-side/pricing-payments → "Pricing & Payments").
  • Fixed a few links that were broken in the source drafts (targets that didn't match real filenames).

Verification

  • Every internal link resolves to a real page (no broken references, no leftover draft paths).
  • prettier --check clean across all touched files.
  • eslint --max-warnings 0 clean on all changed JS/TS (Layout.tsx, next.config.js, _meta.js files).
  • Rendered and reviewed locally (pnpm dev): section appears in the sidebar with the correct order, labels, icon, and working diagrams.

Notes for reviewers

  • No existing pages/URLs are changed, so no redirects are required. Search (Algolia) and the sitemap pick up the new pages automatically on deploy.
  • Content is English-only; other-locale variants are not included.

@brandonleekramer
brandonleekramer requested a review from a team as a code owner August 6, 2026 01:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant