Skip to content

[2026-10] Generate checkout and customer account docs with generate-docs 1.3.0 --strictInput (port of #4763) - #4764

Open
rcaplanshopify wants to merge 3 commits into
2026-10from
generate-docs-1-3-0-strict-input-2026-10
Open

rcaplanshopify wants to merge 3 commits into
2026-10from
generate-docs-1-3-0-strict-input-2026-10

Conversation

@rcaplanshopify

@rcaplanshopify rcaplanshopify commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

What

Port of #4763 to 2026-10.

Why

Without --strictInput, every @publicDocs type reachable from --input becomes 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 --input are roots.

Verification

Generated locally with 1.3.0, with and without the flag:

  • Customer account: output with the flag matches 2026-10 docs: generate customer account data without checkout's types; fix checkout wording #4751's committed file byte for byte. Without the flag: 140 extra types, 86 mis-resolved.
  • Checkout: only ValidationError changes. It previously resolved to the unrelated ValidationError in src/shared.ts (type/code/issues); it now resolves to src/surfaces/checkout/api/shared.ts (message/target), which is the one the docs describe.
  • Every typeName referenced by shopify-dev's 2026-10 MDX (161 checkout, 151 customer account) still resolves.
  • targets.json is byte-identical with and without the flag for both surfaces.

yarn.lock also picks up entries for @arethetypeswrong/cli and publint, which #4645 added to packages/ui-extensions/package.json without updating the root lockfile.

Checklist

  • I have 🎩'd these changes
  • I have updated relevant documentation

rcaplanshopify and others added 2 commits October 21, 2026 13:51
Co-authored-by: claude-fable-5-1 <noreply@anthropic.com>
Co-authored-by: claude-fable-5-1 <noreply@anthropic.com>
@github-actions github-actions Bot added shopify.dev preview needs-rc-port PR against a stable branch awaiting forward-port to the current RC labels Oct 21, 2026
@github-actions

Copy link
Copy Markdown
Contributor

This PR targets a stable release branch (2026-10). Once merged, the change typically also needs to be forward-ported to 2027-01-rc so it ships in the next release.

When you open the forward-port PR, include a line like this in its body so the needs-rc-port label gets removed automatically when that PR merges:

Forward-port of #4764

Accepted formats (comma-separated for multiple):

  • #4764
  • GH-4764
  • 4764
  • https://github.com/Shopify/ui-extensions/pull/4764

If a forward-port isn't needed (e.g., the change is stable-only), you can remove the needs-rc-port label manually.

Co-authored-by: claude-fable-5-1 <noreply@anthropic.com>
@rcaplanshopify
rcaplanshopify force-pushed the generate-docs-1-3-0-strict-input-2026-10 branch from c8d7690 to 073bc2a Compare October 21, 2026 22:04
@rcaplanshopify
rcaplanshopify marked this pull request as ready for review October 21, 2026 23:35
@github-actions

Copy link
Copy Markdown
Contributor

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-rc-port PR against a stable branch awaiting forward-port to the current RC shopify.dev preview

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant