Skip to content

HYDROGEN 2025 07 gen docs v1#3625

Open
laurelthorburn wants to merge 14 commits into2025-07from
2025-07-gen-docs-v1
Open

HYDROGEN 2025 07 gen docs v1#3625
laurelthorburn wants to merge 14 commits into2025-07from
2025-07-gen-docs-v1

Conversation

@laurelthorburn
Copy link
Copy Markdown

@laurelthorburn laurelthorburn commented Mar 26, 2026

PROBLEM

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

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

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

The time has come for hydrogen. 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 versions

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

Failing CI Check

Screenshot 2026-03-31 at 15 30 54

@laurelthorburn laurelthorburn changed the base branch from main to 2025-07 March 26, 2026 13:00
@shopify
Copy link
Copy Markdown
Contributor

shopify bot commented Mar 26, 2026

Oxygen deployed a preview of your 2025-07-gen-docs-v1 branch. Details:

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

Learn more about Hydrogen's GitHub integration.

@laurelthorburn laurelthorburn changed the title 2025 07 gen docs v1 HYDROGEN 2025 07 gen docs v1 Mar 26, 2026
@laurelthorburn laurelthorburn marked this pull request as ready for review March 27, 2026 17:17
@laurelthorburn laurelthorburn requested a review from a team as a code owner March 27, 2026 17:17
@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.
If the changes are user-facing and should cause a version bump, run npm 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.

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.

3 participants