Skip to content

Rename localization-order-status.doc.ts for correct alphabetical sorting#4151

Merged
sordaz00 merged 1 commit into2026-04-rcfrom
fix-order-status-localization-filename
Mar 18, 2026
Merged

Rename localization-order-status.doc.ts for correct alphabetical sorting#4151
sordaz00 merged 1 commit into2026-04-rcfrom
fix-order-status-localization-filename

Conversation

@sordaz00
Copy link
Copy Markdown
Contributor

Summary

Rename file from localization-order-status.doc.ts to order-status-localization.doc.ts so it sorts after order.doc.ts in the generated docs, matching the API name "Order Status Localization API".

Problem

The file was named localization-order-status.doc.ts which caused the "Order Status Localization API" to appear after "Gift Cards API" (because "l" < "m") instead of after "Order API" where it belongs alphabetically.

Fix

Rename to order-status-localization.doc.ts so the file sorts correctly: order.doc.tsorder-status-localization.doc.tsrequire-login.doc.ts

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

@sordaz00 sordaz00 force-pushed the fix-order-status-localization-filename branch from 39788c4 to 7d67410 Compare March 18, 2026 21:42
@sordaz00 sordaz00 merged commit 0d14faf into 2026-04-rc Mar 18, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants