docs: fix typos and a broken image URL in top-level READMEs#7297
Open
andromia3 wants to merge 1 commit intoShopify:mainfrom
Open
docs: fix typos and a broken image URL in top-level READMEs#7297andromia3 wants to merge 1 commit intoShopify:mainfrom
andromia3 wants to merge 1 commit intoShopify:mainfrom
Conversation
- README.md: remove a double space before `[Node.js]` in the "Before you begin" section. - README.md: "You can also use do it through Homebrew" -> "You can also do it through Homebrew" (stray "use"). - README.md: strip the trailing `##` from the "Developing Hydrogen custom storefronts with Shopify CLI" heading. - docs/README.md: the top-of-page `<img>` tag pointed at `Shopify/shopify-cli` (now an archived repo). Updated to `Shopify/cli`, where `assets/logo.png` actually lives.
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
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.
WHY are these changes introduced?
Four small, verifiable issues in the two top-of-repo README files.
WHAT is this pull request doing?
`README.md`:
```diff
-Install the latest version of Node.js and [npm]...
+Install the latest version of Node.js and [npm]...
```
Double space before the `[Node.js]` link.
```diff
-You can also use do it through Homebrew on macOS: `brew tap shopify/shopify && brew install shopify-cli`
+You can also do it through Homebrew on macOS: `brew tap shopify/shopify && brew install shopify-cli`
```
Stray `use` in "You can also use do it".
```diff
-## Developing Hydrogen custom storefronts with Shopify CLI ##
+## Developing Hydrogen custom storefronts with Shopify CLI
```
Trailing `##` on the heading (closing markers like that aren't rendered but they show up in auto-generated TOCs and some linters flag them).
`docs/README.md`:
` src pointed at `Shopify/shopify-cli`, which is now archived. The current repo is `Shopify/cli`, and `assets/logo.png` exists there.
```diff
-<img src="https://github.com/Shopify/shopify-cli/raw/main/assets/logo.png\" alt="Shopify logo" width="150">
+<img src="https://github.com/Shopify/cli/raw/main/assets/logo.png\" alt="Shopify logo" width="150">
```
The `
How to test your changes?
Docs-only. The README renders differently in each case:
Post-release steps
None — docs-only.
Checklist