Skip to content

docs: fix broken links and malformed markdown #3713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andromia3 wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −5
Open

docs: fix broken links and malformed markdown #3713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cookbook/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/CALVER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion packages/hydrogen-react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion packages/hydrogen/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Loading