Skip to content

2026-01 Hydrogen React gen docs v1#3652

Open
laurelthorburn wants to merge 3 commits into2026-01-gen-docs-v1from
hr-2026-01
Open

2026-01 Hydrogen React gen docs v1#3652
laurelthorburn wants to merge 3 commits into2026-01-gen-docs-v1from
hr-2026-01

Conversation

@laurelthorburn
Copy link
Copy Markdown

@laurelthorburn laurelthorburn commented Apr 1, 2026

PROBLEM

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

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

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

The time has come for hydrogen-react. Welcome, you lucky ducky 🦆

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-react versions

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

@shopify
Copy link
Copy Markdown
Contributor

shopify bot commented Apr 1, 2026

Oxygen deployed a preview of your hr-2026-01 branch. Details:

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

Learn more about Hydrogen's GitHub integration.

@laurelthorburn laurelthorburn changed the base branch from main to 2026-01-gen-docs-v1 April 1, 2026 15:12
@laurelthorburn laurelthorburn requested a review from jgray7019 April 1, 2026 16:17
@laurelthorburn laurelthorburn marked this pull request as ready for review April 1, 2026 16:19
@laurelthorburn laurelthorburn requested a review from a team as a code owner April 1, 2026 16:19
@laurelthorburn laurelthorburn changed the title Hr 2026 01 2026-01 Hydrogen React gen docs v1 Apr 1, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 1, 2026

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should these ones be included? or just the hydrogen-react ones?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i built this off the hydrogen script branch and I think since they use the exact same data, I fixed a borked link in both

Screenshot 2026-04-07 at 08 14 39

I plan to merge this one into the hydrogen 2026-01 branch work i did and am waiting for hydrogen's review on

@laurelthorburn laurelthorburn requested a review from jgray7019 April 7, 2026 14:15
@laurelthorburn laurelthorburn force-pushed the 2026-01-gen-docs-v1 branch 18 times, most recently from d73ab92 to 9c101fc Compare April 7, 2026 17:42
@laurelthorburn laurelthorburn force-pushed the 2026-01-gen-docs-v1 branch 5 times, most recently from 82dc400 to 85aa23b Compare April 9, 2026 16:31
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.

2 participants