Skip to content

docs: reorganize Hydrogen documentation into focused skills#3555

Merged
kdaviduik merged 1 commit intomainfrom
kd-add-skills
Mar 16, 2026
Merged

docs: reorganize Hydrogen documentation into focused skills#3555
kdaviduik merged 1 commit intomainfrom
kd-add-skills

Conversation

@kdaviduik
Copy link
Copy Markdown
Contributor

@kdaviduik kdaviduik commented Mar 9, 2026

Summary

Part of https://github.com/Shopify/developer-tools-team/issues/1052.

  • Create hydrogen-release-process skill — dedicated on-demand runbook for the full release flow (standard, back-fix, snapshot), manual vs automatic steps, changelog.json updates, h2 upgrade enablement, failure recovery, and Dependabot review guidance
  • Slim CLAUDE.md from ~340 to ~195 lines — keeps only changeset rules (now 3 rules, adding hydrogen-react and CI blind-spot rules), skeleton/CLI quick reference, and circular dependency explanation
  • Clean hydrogen-dev-workflow skill — removes release process and changeset sections that now live elsewhere; fixes dangling cross-references
  • Update hydrogen-versioning skill — cross-references now point to the new release skill

Stale reference fixes

  • changesets.ymlrelease.yml (unified workflow)
  • next-release.ymlnext-release job in release.yml
  • changesets-back-fix.ymlbackfix-release job in release.yml
  • latestBranchlatestVersion in PR title documentation
  • Hardcoded ~3.80.4 CLI version removed from diagram
  • Fragile line-number references removed
  • latestBranch described as dynamically computed (not hardcoded)

Why

CLAUDE.md loads into every Claude Code session. ~145 lines of release process detail were loading even for tasks like fixing a typo or reviewing a bug fix. Moving this content to an on-demand skill means it only loads when triggered by keywords like "release", "back-fix", or "changelog.json".

Out of scope

docs/CALVER.md has 6 stale references to changesets.yml that should be release.yml — noted for a separate cleanup.

@shopify
Copy link
Copy Markdown
Contributor

shopify Bot commented Mar 9, 2026

Oxygen deployed a preview of your kd-add-skills branch. Details:

Storefront Status Preview link Deployment details Last update (UTC)
Skeleton (skeleton.hydrogen.shop) ✅ Successful (Logs) Preview deployment Inspect deployment March 9, 2026 5:16 AM

Learn more about Hydrogen's GitHub integration.

@kdaviduik kdaviduik marked this pull request as ready for review March 9, 2026 05:15
@kdaviduik kdaviduik requested a review from a team as a code owner March 9, 2026 05:15
@binks-code-reviewer
Copy link
Copy Markdown

🤖 Code Review · #projects-dev-ai for questions
React with 👍/👎 or reply — all feedback helps improve the agent.

Complete - No issues

📋 History

✅ No issues

Comment thread CLAUDE.md
- This package calls the `hydrogen init` command from `@shopify/cli-hydrogen`
1. **Default behavior**: Uses the skeleton template bundled inside `@shopify/create-hydrogen`
- No network fetch required—the template is pre-bundled at build time
- This is why `create-hydrogen` must be bumped when skeleton changes
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

i wonder if we can just use pnpm workspaces for this and omit this section entirely

(by adding skeleton as a dep inside create-hydrogen)


# Hydrogen Development Workflow

Development practices and workflow guide for engineers working on Shopify's headless storefront ecosystem. The Hydrogen framework repo is [`Shopify/hydrogen`](https://github.com/Shopify/hydrogen). For domain context, see the `headless-storefronts-context` skill. For repo locations, see the `shopify-repos` skill.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

are those other skills real? could not find headless-storefronts-context nor shopify-repos

Copy link
Copy Markdown
Contributor

@fredericoo fredericoo Mar 11, 2026

Choose a reason for hiding this comment

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

yep it’s here

so this assumes you have the Vault MCP working with the claude plugin? idk if it’s ok for us to mention them across domains like that

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think mentioning the other skills is fine, but the internal context needs to stay internal. What do you think of just modifying it to say something like "If you are a Shopify employee, run to get access to the headless-storefronts-context skill (for domain context)"?

Copy link
Copy Markdown
Contributor

@fredericoo fredericoo Mar 11, 2026

Choose a reason for hiding this comment

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

yeah i think that’s fine

ps.: i’d place this skill inside skeleton and publish it for other agents/tools too!

Copy link
Copy Markdown
Contributor

@fredericoo fredericoo left a comment

Choose a reason for hiding this comment

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

lgtm! left a couple of suggestions but we can move files later, and having those on main will be an insta benefit

@kdaviduik kdaviduik merged commit 723c8cf into main Mar 16, 2026
18 checks passed
@kdaviduik kdaviduik deleted the kd-add-skills branch March 16, 2026 17:05
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