Skip to content

Fix broken and incorrect documentation links across CA pages#4300

Open
sordaz00 wants to merge 2 commits into2026-04-rcfrom
fix/ca-broken-links-2026-04-rc
Open

Fix broken and incorrect documentation links across CA pages#4300
sordaz00 wants to merge 2 commits into2026-04-rcfrom
fix/ca-broken-links-2026-04-rc

Conversation

@sordaz00
Copy link
Copy Markdown
Contributor

@sordaz00 sordaz00 commented Apr 15, 2026

Summary

  • Fix session token links pointing to non-existent /apis/session-token page — changed to /docs/apps/build/authentication-authorization/session-tokens
  • Fix appMetafields description links: shopify.extension.toml now points to metafield definition docs, app owned metafields now points to correct anchor
  • Fix availablePaymentOptions linking to checkout surface instead of customer-account
  • Fix <header> ARIA role linking to main_role instead of banner_role
  • Add missing {API_VERSION} segments to Localization API, Section, Avatar, CustomerAccountAction links
  • Change unstable version refs to {API_VERSION} or latest
  • Fix "registering events" text and link to "handling events"

Closes:

Test plan

  • Verify links resolve correctly in local world preview
  • No generated files included

Made with Cursor

@github-actions
Copy link
Copy Markdown
Contributor

🚨🚨🚨 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! 🙏

Copy link
Copy Markdown
Contributor

@mcvinci mcvinci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @sordaz00! Do we need to apply these changes to other versions as well?

Also, I just realized we're targeting the 2026-04-rc version. We'll likely need to target 2026-04 and 2026-07-rc instead.

- Fix session token links pointing to non-existent page
- Fix appMetafields shopify.extension.toml and app owned metafields links
- Fix availablePaymentOptions linking to checkout surface instead of CA
- Fix header ARIA role linking to main_role instead of banner_role
- Add missing {API_VERSION} segments to Localization, Section, Avatar links
- Change unstable version refs to {API_VERSION} or latest
- Fix "registering events" text and link to "handling events"

Made-with: Cursor
@sordaz00 sordaz00 force-pushed the fix/ca-broken-links-2026-04-rc branch from 93dafe9 to f35b868 Compare April 15, 2026 16: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.

2 participants