Skip to content

Docs: restructure Subgraphs, Substreams, Indexing & Resources#1113

Closed
brandonleekramer wants to merge 3 commits into
mainfrom
subgraph-reorg
Closed

Docs: restructure Subgraphs, Substreams, Indexing & Resources#1113
brandonleekramer wants to merge 3 commits into
mainfrom
subgraph-reorg

Conversation

@brandonleekramer

Copy link
Copy Markdown
Member

Summary

A large information-architecture overhaul of the Subgraphs, Substreams, Indexing, and Resources sections — reordering, regrouping, renaming, moving, and removing pages — plus the nginx.conf redirects to preserve every old URL and a handful of supporting label/link edits. Changes are structural (_meta.js / _meta-titles.json), file moves, redirects, and small edits; page prose was not rewritten.

Every structural change was validated with a production next build (compiles, all pages generate, 0 _meta validation errors).

Subgraphs

New top-level order: Overview, Quick Start, Providers, Public Subgraphs, Developing, Querying, Tooling, Best Practices, How-to Guides.

  • Overview — the "Subgraphs" page (previously under Developing) is promoted to the section landing/default.
  • Providers (folder, renamed from "Subgraph Providers") → Subgraph Studio now contains: Overview (fka Billing), Managing API Keys (moved from Querying), Upgrade Indexer, Fair Use Policy, Studio FAQs (moved from Resources).
  • Public Subgraphs (fka Explorer, briefly "Find Existing Subgraphs"; URL slug remains existing-subgraphs) is now a folder: Using Graph Explorer, Standardized Subgraphs, Agent0 Subgraphs, Polymarket Subgraphs.
  • Developing → Introduction, Creating, Deploying/Publishing (consolidated from separate Deploying + Publishing folders), Managing, Developer FAQ.
    • Creating order/labels: Starting Your Subgraph, Graph CLI, Subgraph Manifest, GraphQL Schema, AssemblyScript Mappings, AssemblyScript API, Local Dev Mode, Advanced Features.
    • Deploying/Publishing labels: Deploy to Studio, Deploy to Multiple Networks, Publish to Network.
  • Querying order/labels: How to Query, GraphQL API, Querying Best Practices, Querying from Apps, Subgraph vs Deployment IDs, Graph Client, Querying in Python. (Distributed Systems removed; Managing API Keys moved into Subgraph Studio.)
  • Tooling (new folder): MCPs, SKILLs, Smart Contract Analysis with Cana CLI, Subgraph Uncrashable, Subgraph Linter, Matchstick Unit Testing (moved from Creating), x402 Payments.
  • Best Practices reordered: Immutable Entities and Bytes as IDs, Arrays with @derivedFrom, Pruning with indexerHints, Avoiding eth_calls, Timeseries and Aggregations, Grafting and Hotfixing.
  • How-to Guides trimmed to the 7 remaining guides (Agent0/Polymarket moved to Public Subgraphs; x402-payments/subgraph-uncrashable/subgraph-linter/contract-analyzer moved to Tooling) and relabeled: Transfer to The Graph, Subgraph Grafting, Subgraph Forking, Composable Subgraphs, Using Enums, Securing API Keys with Next.js, NEAR Subgraphs.

Substreams

Order: Overview, Quick Start, Providers, Public Substreams, Developing, Publishing, Tooling.

  • Introduction → Overview.
  • Providers (new folder) → The Graph Market.
  • Public Substreams (new folder) → Using Substreams.dev.
  • Tooling (new folder) → MCPs, Skills.

Indexing

  • Section renamed "Indexer Tooling" in the sidebar nav.
  • The old "Indexer Tooling" (tooling/) subfolder was dissolved; Firehose, Graph Node, GraphCast promoted to the top level.
  • New order: Overview, Firehose, Graph Node, GraphCast, GraphTally for Indexers, Supported Networks and Node Requirements, New Chain Integration, Chain Integration Process.
  • Relabels: GraphCast, GraphTally for Indexers (fka tap), Supported Networks and Node Requirements, Chain Integration Process.

Global navigation

  • AI Tooling (fka "The Graph's AI") moved to the top of the left sidebar.
  • Graph Horizon → Data Services; its "Overview" page relabeled "Horizon Overview".

Removals (deleted pages)

  • Archived section removed entirely: arbitrum/arbitrum-faq, arbitrum/l2-transfer-tools-faq, arbitrum/l2-transfer-tools-guide, sunrise.
  • Resources → Migration Guides removed: AssemblyScript Migration Guide, GraphQL Validations Migration Guide, Migrate from Alchemy (and the folder).
  • Distributed Systems removed.
  • Inbound links to removed pages were unlinked (link text preserved).

Supported Networks page

  • The "Integrate new network" link now points to mailto:info@thegraph.foundation.
  • Consolidated the separate Substreams and Firehose legend boxes into one Firehose/Substreams box.

Redirects (nginx.conf)

Every moved, renamed, or removed URL has a permanent (301) redirect. A full audit confirmed every pre-existing route still resolves (redirect or live page) and no redirect points to a dead page.

Moves/renames →

  • subgraphs/billingsubgraphs/providers/subgraph-studio/introduction
  • subgraphs/explorersubgraphs/existing-subgraphs/explorer
  • subgraphs/upgrade-indexer, subgraphs/fair-use-policy, resources/subgraph-studio-faqsubgraphs/providers/subgraph-studio/*
  • subgraphs/developing/subgraphssubgraphs/overview
  • subgraphs/developing/deploying/* & subgraphs/developing/publishing/*subgraphs/developing/deploying-publishing/*
  • subgraphs/subgraph-mcp/* & subgraphs/skillssubgraphs/tooling/*
  • subgraphs/guides/{agent0,polymarket}subgraphs/existing-subgraphs/*
  • subgraphs/guides/{x402-payments,subgraph-uncrashable,subgraph-linter,contract-analyzer}subgraphs/tooling/*
  • subgraphs/querying/managing-api-keyssubgraphs/providers/subgraph-studio/managing-api-keys
  • subgraphs/developing/creating/unit-testing-frameworksubgraphs/tooling/unit-testing-framework
  • substreams/introductionsubstreams/overview
  • substreams/skills & substreams/substreams-mcp/*substreams/tooling/*
  • indexing/tooling/{firehose,graph-node,graphcast}indexing/*
    Removals →
  • resources/migration-guides/assemblyscript-migration-guide → AssemblyScript API page (subgraphs/developing/creating/graph-ts/README)
  • resources/migration-guides/graphql-validations-migration-guide → GraphQL API page (subgraphs/querying/graphql-api)
  • resources/migration-guides/migrate-from-alchemy → Transfer to The Graph
  • archived/sunrise/ (+ legacy alias /sunrise/, /network-transition-faq/) → https://thegraph.com/blog/unveiling-updated-sunrise-decentralized-data/
  • archived/arbitrum/* (+ legacy aliases /arbitrum-faq/, /arbitrum/l2-transfer-tools-faq/, /arbitrum/l2-transfer-tools-guide/) → https://thegraph.com/blog/the-graph-L2-scaling-with-arbitrum/
  • Removed 6 now-dangling redirects that had pointed at deleted pages.
  • Distributed Systems has no redirect (fully removed).

Supporting file changes

  • _meta.js / _meta-titles.json across all affected sections.
  • nginx.conf — all redirects above.
  • website/route-lockfile.txt — updated to the new route set (regenerated by pnpm build).
  • Internal links updated across .mdx files, HomePage.tsx, supportedNetworks/ResourceCards.tsx, supportedNetworks/NetworksTable.tsx, and index.json.
  • next.config.js — nav order + labels (AI Tooling to top, Data Services, Indexer Tooling).

@brandonleekramer brandonleekramer requested a review from a team as a code owner July 10, 2026 20:50
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