From 46a1700a347e211759432691cb6c38d9199f691c Mon Sep 17 00:00:00 2001 From: andromia3 Date: Tue, 14 Apr 2026 15:19:49 +0100 Subject: [PATCH] docs: fix broken links and malformed markdown - packages/hydrogen/README.md: fix broken relative CHANGELOG link. ./packages/hydrogen/CHANGELOG.md resolved to packages/hydrogen/packages/hydrogen/CHANGELOG.md from this file's location; correct path is ./CHANGELOG.md. - packages/hydrogen-react/README.md: remove malformed self-referential markdown link [text](<(#anchor)>). The anchor does not exist and the link appeared inside the section it pointed to. - docs/CALVER.md: fix two broken links in the Related Documentation section. The release process section moved to .claude/skills/hydrogen-release-process/SKILL.md, and changeset-protection-utils.js lives under .changeset/, not .github/scripts/. - cookbook/README.md: recipe.yaml is a YAML file, not a JSON file, and "containig" -> "containing". --- cookbook/README.md | 2 +- docs/CALVER.md | 4 ++-- packages/hydrogen-react/README.md | 2 +- packages/hydrogen/README.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/cookbook/README.md b/cookbook/README.md index 69861565cf..1b87eb3c00 100644 --- a/cookbook/README.md +++ b/cookbook/README.md @@ -41,7 +41,7 @@ A _recipe_ is a reproducible sequence of steps meant to be applied to the [skele Each recipe is located in the [cookbook's recipes folder](/cookbook/recipes/) and is structured with a specific set of conventions. This is how a recipe folder is organized: -- `recipe.yaml`: the JSON file containig the whole recipe definition, in a machine-readable format. +- `recipe.yaml`: the YAML file containing the whole recipe definition, in a machine-readable format. - `ingredients/`: a folder containing _new_ files that the recipe introduces. They will be copied as-is to the skeleton template. - `patches/`: a folder containing patches to be applied to existing files in the skeleton template. The file ↔ patch mappings are defined in the `recipe.yaml` file under the `ingredients` key. - `README.md`: the human-readable Markdown render of the recipe, based off of the `recipe.yaml` file. diff --git a/docs/CALVER.md b/docs/CALVER.md index 4225de1cea..4575f29241 100644 --- a/docs/CALVER.md +++ b/docs/CALVER.md @@ -599,7 +599,7 @@ Potential enhancements being considered: ## Related Documentation -- [Hydrogen Release Process](../CLAUDE.md#hydrogen-release-process) - Complete release workflow +- [Hydrogen Release Process](../.claude/skills/hydrogen-release-process/SKILL.md) - Complete release workflow - [Major Protection Workflow](../.github/workflows/major-protection.yml) - Protection implementation -- [Protection Utilities](../.github/scripts/changeset-protection-utils.js) - Shared utilities +- [Protection Utilities](../.changeset/changeset-protection-utils.js) - Shared utilities - [.changeset/README.md](../.changeset/README.md) - Changesets documentation \ No newline at end of file diff --git a/packages/hydrogen-react/README.md b/packages/hydrogen-react/README.md index 705d527e50..68baa371f4 100644 --- a/packages/hydrogen-react/README.md +++ b/packages/hydrogen-react/README.md @@ -68,7 +68,7 @@ The following will help you troubleshoot common problems in this version of Hydr ### GraphQL autocompletion -If you can't get [GraphQL autocompletion](<(#storefront-api-graphql-autocompletion)>) to work, then try restarting the GraphQL server in your IDE. +If you can't get GraphQL autocompletion to work, then try restarting the GraphQL server in your IDE. For example, in VSCode do the following: diff --git a/packages/hydrogen/README.md b/packages/hydrogen/README.md index 2e1f1fc6ff..7ea632c0c1 100644 --- a/packages/hydrogen/README.md +++ b/packages/hydrogen/README.md @@ -18,5 +18,5 @@ npm create @shopify/hydrogen@latest - Interested in contributing to Hydrogen? [Read our contributing guide](../../CONTRIBUTING.md) - Want to learn more? [Check out the Hydrogen docs on Shopify.dev](https://shopify.dev/custom-storefronts/hydrogen) - Questions? Feedback? Feature requests? [Discussions](https://github.com/Shopify/hydrogen/discussions) -- Upgrading from a previous version? [View the Changelog](./packages/hydrogen/CHANGELOG.md) +- Upgrading from a previous version? [View the Changelog](./CHANGELOG.md) - Looking for Hydrogen v1? [The source code has been moved](https://github.com/Shopify/hydrogen-v1)