Repository navigation
[2026-10] Generate checkout and customer account docs with generate-docs 1.3.0 --strictInput (port of #4763) - #4764
rcaplanshopify wants to merge 3 commits into
Conversation
Co-authored-by: claude-fable-5-1 <noreply@anthropic.com>
Co-authored-by: claude-fable-5-1 <noreply@anthropic.com>
|
This PR targets a stable release branch ( When you open the forward-port PR, include a line like this in its body so the Accepted formats (comma-separated for multiple):
If a forward-port isn't needed (e.g., the change is stable-only), you can remove the |
Co-authored-by: claude-fable-5-1 <noreply@anthropic.com>
c8d7690 to
073bc2a
Compare
|
We detected some changes in |
What
Port of #4763 to
2026-10.@shopify/generate-docsfrom 1.2.2 to 1.3.0 (Shopify/generate-docs#463) and pass its new opt-in--strictInputflag when building the checkout and customer account docs. Admin and POS are unchanged.Why
Without
--strictInput, every@publicDocstype reachable from--inputbecomes a documentation root, including types imported from other surfaces. Customer account docs ended up documenting 140 checkout-only types and resolving 86 same-named types (Attribute,CartLine,Country, …) to checkout's definition instead of its own; #4751 worked around that by hand. With the flag, only types defined inside--inputare roots.Verification
Generated locally with 1.3.0, with and without the flag:
ValidationErrorchanges. It previously resolved to the unrelatedValidationErrorinsrc/shared.ts(type/code/issues); it now resolves tosrc/surfaces/checkout/api/shared.ts(message/target), which is the one the docs describe.typeNamereferenced by shopify-dev's 2026-10 MDX (161 checkout, 151 customer account) still resolves.targets.jsonis byte-identical with and without the flag for both surfaces.yarn.lockalso picks up entries for@arethetypeswrong/cliandpublint, which #4645 added topackages/ui-extensions/package.jsonwithout updating the root lockfile.Checklist