COMDOX-1733: paginate GraphQL API reference for all schema versions#584
Merged
Conversation
…hunks Replace byte-sized chunkByH3 splitting with fixed alphabetical type ranges (a-b through t-z). Write separate reference pages (queries, mutations, types-*) with one Fragment each instead of stacking all chunks on index.md. Point the default 2.4.9 output at src/pages/reference/graphql/latest/.
Split each schema version into queries, mutations, and six alphabetical type pages so no single page embeds the full ~950 KB reference. Move the default 2.4.9 reference from /reference/graphql/ to /reference/graphql/latest/. Add sub-page navigation in config.md for SaaS, latest (2.4.9), 2.4.8, 2.4.7, and 2.4.6. Update schema guide cross-links to the new latest path. BREAKING CHANGE: 2.4.9 GraphQL API reference URLs move from /reference/graphql/ to /reference/graphql/latest/ (for example /reference/graphql/index.md → /reference/graphql/latest/index.md). External deep links to the old path will 404 unless redirects are added.
…nes and trailing whitespace
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
…aphQL docs restructuring
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
keharper
requested changes
Jun 24, 2026
…after GraphQL docs restructuring" and fix the GraphQL references This reverts commit 04a7d05.
… into ds_comdox-1733
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
keharper
approved these changes
Jun 24, 2026
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.
Purpose of this pull request
Paginate the Commerce GraphQL API reference so each schema version loads in smaller, navigable pages instead of a single ~950 KB topic. This fixes rendering and navigation issues on developer.adobe.com while keeping SpectaQL-generated content in sync.
/reference/graphql/to/reference/graphql/latest/. Remove the old monolithicreference/graphql/index.mdtopic.config.mdfor each paginated reference section./reference/graphql/latest/and per-section paths (for examplemutations.md,types-a-b.md).generate-spectaql-md.jsto emit letter-range type chunks and reference wrapper pages; sanitize SpectaQL Markdown (collapse excess blank lines, strip trailing whitespace).Floatscalar descriptions across schema JSON and generated type pages.Affected pages
Representative published topics (full reference set spans SaaS, latest, 2.4.8, 2.4.7, and 2.4.6):
Note: External deep links to the former 2.4.9 path (
/commerce/webapi/reference/graphql/) will 404 unless redirects are added separately.Additional information
major-updatelabel/commerce/webapi/reference/graphql/Preview
https://developer-stage.adobe.com/commerce/webapi/
Tracking
Internal: COMDOX-1733
Closes #581
What's New highlights
whatsnew
The GraphQL API reference is now split into paginated topics for faster loading and easier navigation. Updated the following documentation: