Shopify / ui-extensions

MIT License
265 stars 37 forks source link

Update Customer Account UI extensions Configuration page #2056

Closed jrrafols closed 3 months ago

jrrafols commented 3 months ago

Background

Resolves https://github.com/Shopify/core-issues/issues/71478

Changes are needed to the content of https://shopify.dev/docs/api/customer-account-ui-extensions/unstable/configuration now that extensions can write to metafields using the Customer Account API

[!NOTE] Will not be shipped until the Customer Account UI extensions metafield tutorial is completed. Getting reviews early to ensure that content has been approved by all parties. Furthermore, a corresponding change will need to be shipped in shopify-dev for this content to appear in dev docs.

This content cannot be gated behind a feature flag (see here) so we'll need to rely on shipping it at the appropriate date

Solution

The content has been updated as per https://docs.google.com/document/d/1iYD-zJYZ3s_HPHjiQGanC3EId-Koexa61w4Kclpttvs/edit

Notably, the Metafields section of the page will now serve as a "pathfinder" to either link to a tutorial for writing to metafields from an extension or to link to the Checkout UI Extension configuration page.

🎩

View the page in my spin instance here: https://shopify-dev.metafield-docs.jr-rafols.us.spin.dev/docs/api/customer-account-ui-extensions/unstable/configuration (Resume link)

Network access

Before image

After image

Metafields

Before image

After image

Checklist