Skip to content

Remove self-referential Storefront API link from query description (2026-04)#4450

Merged
timtrevor-shopify merged 1 commit into
2026-04from
2026-04-storefront-api-query-update
May 6, 2026
Merged

Remove self-referential Storefront API link from query description (2026-04)#4450
timtrevor-shopify merged 1 commit into
2026-04from
2026-04-storefront-api-query-update

Conversation

@timtrevor-shopify
Copy link
Copy Markdown
Contributor

Summary

Removes the self-referential "Refer to Storefront API access examples for more information" link from the query property description in StandardApi. The link points to the same page the reader is already on, which is confusing and unhelpful.

Fixes https://github.com/shop/issues-learn/issues/2084

Test plan

  • Verify the generated docs no longer include the self-referential link on the Storefront API page

Made with Cursor

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

🚨🚨🚨 Docs migration in progress 🚨🚨🚨

We are actively migrating UI extension reference docs to MDX in the areas/platforms/shopify-dev zone of the monorepo. This impacts docs for the following surfaces:

During this migration, please be aware of the following:

.doc.ts files are being deprecated. Changes to .doc.ts files in this repo will not be reflected in the new MDX-based docs. If you need to update docs for a reference that has already been migrated, make your changes directly in the areas/platforms/shopify-dev zone of the monorepo instead.

Doc comments in .ts source files (the comment blocks above types and functions) are also affected. Generating docs from these comments currently requires a newer version of the @shopify/generate-docs library that isn't yet available. Updates to doc comments may not produce the expected output until the migration is complete.

Examples that previously lived in this repo are being moved to the areas/platforms/shopify-dev zone of the monorepo and should be authored there going forward.

What should I do?

  • If your PR includes changes to .doc.ts files, doc comments, or examples, please reach out to us in #devtools-proj-templated-refs so we can help ensure your updates are captured correctly.
  • If your PR is limited to source code changes (non-docs), you can ignore this notice.

Thanks for your patience while we complete the migration! 🙏

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

@github-actions github-actions Bot added the needs-rc-port PR against a stable branch awaiting forward-port to the current RC label May 6, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

This PR targets a stable release branch (2026-04). Once merged, the change typically also needs to be forward-ported to 2026-07-rc so it ships in the next release.

When you open the forward-port PR, include a line like this in its body so the needs-rc-port label gets removed automatically when that PR merges:

Forward-port of #4450

Accepted formats (comma-separated for multiple):

  • #4450
  • GH-4450
  • 4450
  • https://github.com/Shopify/ui-extensions/pull/4450

If a forward-port isn't needed (e.g., the change is stable-only), you can remove the needs-rc-port label manually.

@timtrevor-shopify timtrevor-shopify requested a review from rennyG May 6, 2026 22:18
@timtrevor-shopify timtrevor-shopify merged commit 6c13baf into 2026-04 May 6, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-rc-port PR against a stable branch awaiting forward-port to the current RC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants