Skip to content

fix(docs): Rename localization.doc.ts to fix URL slug collision (2024-07)#4106

Open
sordaz00 wants to merge 1 commit into2024-07from
localization-order-apis-2024-07
Open

fix(docs): Rename localization.doc.ts to fix URL slug collision (2024-07)#4106
sordaz00 wants to merge 1 commit into2024-07from
localization-order-apis-2024-07

Conversation

@sordaz00
Copy link
Contributor

Summary

  • Renames order-status-api/localization.doc.tsorder-status-api/localization-order-status.doc.ts
  • Fixes URL slug collision where both "Localization API" and "Localization API (Order Status)" were generating the same URL /apis/localization

Problem

Both APIs had source files named localization.doc.ts, causing the doc generation system to produce identical URL slugs.

Solution

Rename the order-status version to localization-order-status.doc.ts so each API gets a unique slug:

  • Localization API → /localization
  • Localization API (Order Status) → /localization-order-status

Test plan

  • Verify docs generate without errors
  • Confirm both Localization APIs have distinct URLs

Made with Cursor

Both "Localization API" and "Localization API (Order Status)" were generating
the same URL slug because their source files had the same name. Renaming the
order-status version to localization-order-status.doc.ts ensures unique slugs:
- Localization API → /localization-api
- Localization API (Order Status) → /localization-order-status-api

Made-with: Cursor
@github-actions
Copy link
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! 🙏

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.

1 participant