Skip to content

docs: fix SpecVersion links, document first limits and unique version labels - #1128

Open
yash251 wants to merge 1 commit into
graphprotocol:mainfrom
yash251:yash/944-docs-fixes
Open

yash251 wants to merge 1 commit into
graphprotocol:mainfrom
yash251:yash/944-docs-fixes

Conversation

@yash251

@yash251 yash251 commented Nov 13, 2026

Copy link
Copy Markdown
Contributor

Changes

Subgraph manifest page (#944): subgraphs/developing/creating/subgraph-manifest.mdx

  • SpecVersion 1.3.0 now links to /subgraphs/guides/subgraph-composition/ instead of the 404 /cookbook/subgraph-composition-three-sources.
  • The other SpecVersion table links used /developing/creating/... paths, which have no redirect in nginx.conf. They now use /subgraphs/developing/creating/.... The anchors are unchanged and match the existing headings.
  • Other broken links on the same page, as the comment on Broken URL in SpecVersion Releases #944 reported:
    • The graft base link (/developing/creating-a-subgraph/#grafting-onto-existing-subgraphs) redirected to a page that doesn't have that anchor. It now points to /subgraphs/developing/creating/advanced/#grafting-onto-existing-subgraphs.
    • #time-travel-queries now reads #time-travel-queries-example, which matches the current heading ("Time-travel Queries Example") in graphql-api.mdx.

GraphQL API page (#977): subgraphs/querying/graphql-api.mdx

  • Added a note to the Pagination section. When first is omitted, a query returns at most 100 entities. The maximum is 1000, the Graph Node default set by GRAPH_GRAPHQL_MAX_FIRST. Asking for more returns an error.
  • Sources (graph-node master @ 3b2f05d4b5213f7ddcfcd5a8005d291be1b38fd1):
    • graph/src/schema/api.rs: first.default_value = Some(s::Value::Int(100.into()))
    • graph/src/env/graphql.rs: #[envconfig(from = "GRAPH_GRAPHQL_MAX_FIRST", default = "1000")]
    • graphql/src/store/query.rs: returns RangeArgumentsError when first is greater than max_first
    • docs/environment-variables.md: "If not provided, first defaults to 100. The default value for GRAPH_GRAPHQL_MAX_FIRST is 1000."

Subgraph Studio page (#961): subgraphs/developing/deploying-publishing/using-subgraph-studio.mdx

Checks

Run locally after pnpm install --frozen-lockfile. The lockfile is unchanged.

  • pnpm lint: passed
  • pnpm prettier:check: passed
  • pnpm typecheck: passed

Only English source pages were edited.

… labels

- subgraph-manifest: point SpecVersion 1.3.0 to the Subgraph Composition
  guide and fix the other outdated /developing/... links and anchors on
  the page (graphprotocol#944)
- graphql-api: note the default (100) and maximum (1000) values of `first`
  (graphprotocol#977)
- using-subgraph-studio: state that version labels must be unique (graphprotocol#961)
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