Skip to content

2026-04 update gen docs for hydrogen and hydrogen-react#3715

Draft
laurelthorburn wants to merge 6 commits intomainfrom
2026-04-rc-gen-docs-update
Draft

2026-04 update gen docs for hydrogen and hydrogen-react#3715
laurelthorburn wants to merge 6 commits intomainfrom
2026-04-rc-gen-docs-update

Conversation

@laurelthorburn
Copy link
Copy Markdown

@laurelthorburn laurelthorburn commented Apr 14, 2026

PROBLEM

Related to https://github.com/shop/issues-learn/issues/1460

Sibling pr with top hat changes: https://github.com/shop/world/pull/609065

We have released generate-docs v1 and are now migrating references using the platform.

SOLUTION

  1. Update generate-docs package
  2. Modify build script to output just the generate_docs_data_v2.json and send a copy to the shopify-dev repo
  3. Add @publicDocs tag to all top level types (and possibly update js doc comments if descriptions were missing)

TOP HATTING

All top hatting will occur in the shopify-dev pr affiliated with the four migrated hydrogen versions

https://github.com/shop/world/pull/609065

@shopify
Copy link
Copy Markdown
Contributor

shopify bot commented Apr 14, 2026

Oxygen deployed a preview of your 2026-04-rc-gen-docs-update branch. Details:

Storefront Status Preview link Deployment details Last update (UTC)
Skeleton (skeleton.hydrogen.shop) ✅ Successful (Logs) Preview deployment Inspect deployment April 14, 2026 8:54 PM

Learn more about Hydrogen's GitHub integration.

@laurelthorburn laurelthorburn force-pushed the 2026-04-rc-gen-docs-update branch from 80ff37f to 229cb05 Compare April 14, 2026 17:08
@laurelthorburn laurelthorburn changed the title upgrade gen docs 2026-04 update gen docs for hydrogen and hydrogen-react Apr 14, 2026
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