Enrich JSDoc for Platform APIs property descriptions (2026-04-rc)

[SteveSill]

Summary

• Ports enriched JSDoc descriptions from checkout-web to ui-extensions 2026-04-rc for 9 Platform APIs: Analytics, Extension, I18n, I18nTranslate, Localization, Session Token, Shop, Storage
• Replaces circular/terse descriptions with actionable JSDoc that explains what each API does, when to use it, and what values to expect
• Adds type-level descriptions for Analytics, Shop, I18n, I18nTranslate, Localization, Editor, Storage, and SessionToken interfaces

Test plan

• Run yarn docs:checkout 2026-04-rc to verify doc generation succeeds
• Verify generated_docs_data_v2.json includes enriched descriptions
• Review generated descriptions in shopify.dev preview

Partially closes https://github.com/shop/issues-learn/issues/1046

[github-actions]

🚨🚨🚨 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:

• Admin UI extensions
• App Home
• Checkout UI extensions
• Customer account UI extensions
• POS UI extensions

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

[rennyG]

Thanks @SteveSill! Approving to unblock. It looks like they haven't got the new 2026-07-rc folder in, so nothing to cherry-pick to that folder, I don't think.

On question though. Do these changes need to be added to this repo?