docs: fix broken links and malformed markdown#3713
Open
andromia3 wants to merge 1 commit intoShopify:mainfrom
Open
docs: fix broken links and malformed markdown#3713andromia3 wants to merge 1 commit intoShopify:mainfrom
andromia3 wants to merge 1 commit intoShopify:mainfrom
Conversation
- 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".
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #3712, this one targets genuinely broken links rather than typos. Each fix was verified by checking the target file/anchor exists at the claimed location.
Fixes
packages/hydrogen/README.md— broken relative CHANGELOG link```diff
-- Upgrading from a previous version? View the Changelog
+- Upgrading from a previous version? View the Changelog
```
The link was copied from the root `README.md` without adjusting the relative path. From `packages/hydrogen/README.md`, `./packages/hydrogen/CHANGELOG.md` resolves to `packages/hydrogen/packages/hydrogen/CHANGELOG.md`, which doesn't exist.
packages/hydrogen-react/README.md— malformed self-referential link```diff
-If you can't get 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.
```
The markdown link `text` is malformed (stray angle brackets and parentheses in the URL slot), the anchor `#storefront-api-graphql-autocompletion` does not exist in the file, and the link sits inside the `### GraphQL autocompletion` section it pointed to. Dropped the link and kept plain text.
docs/CALVER.md— two broken links in Related Documentation```diff
-- Hydrogen Release Process - Complete release workflow
+- Hydrogen Release Process - Complete release workflow
```
There is no `#hydrogen-release-process` anchor in `CLAUDE.md`. That file actually points readers to the release-process skill (`CLAUDE.md` line 25: "see the `hydrogen-release-process` skill"). Updated to link straight to `.claude/skills/hydrogen-release-process/SKILL.md`, which exists.
```diff
-- Protection Utilities - Shared utilities
+- Protection Utilities - Shared utilities
```
`.github/scripts/changeset-protection-utils.js` does not exist. The file lives at `.changeset/changeset-protection-utils.js`.
(Note: the following bullet, `.changeset/README.md`, also points to a file that doesn't exist. Left alone since it's unclear whether the right fix is to remove the bullet or to create the README — happy to do either in a follow-up if a maintainer has a preference.)
cookbook/README.md— wrong file format + typo```diff
-- `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.
```
`recipe.yaml` is a YAML file (has a `# yaml-language-server: $schema` header and uses YAML syntax), not a JSON file. Also fixed `containig` → `containing`.
No functional changes, docs-only, no changeset needed.