Skip to content

docs: fix typos and a broken image URL in top-level READMEs#7297

Open
andromia3 wants to merge 1 commit intoShopify:mainfrom
andromia3:docs/fix-readme-typos
Open

docs: fix typos and a broken image URL in top-level READMEs#7297
andromia3 wants to merge 1 commit intoShopify:mainfrom
andromia3:docs/fix-readme-typos

Conversation

@andromia3
Copy link
Copy Markdown

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`:
```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 `` src pointed at `Shopify/shopify-cli`, which is now archived. The current repo is `Shopify/cli`, and `assets/logo.png` exists there.

How to test your changes?

Docs-only. The README renders differently in each case:

  • Hover the "Node.js" link in the rendered "Before you begin" section — the double space is visible.
  • Read the "Developing themes" section out loud — "use do it" is visibly wrong.
  • The Hydrogen heading's TOC anchor was previously `shopify-cli-` (trailing dash from the `##`).
  • `docs/README.md` now pulls the logo from a live repo instead of an archived one.

Post-release steps

None — docs-only.

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes — this is the docs change
  • I've considered analytics changes to measure impact — N/A, docs-only
  • The change is user-facing, so I've added a changelog entry with `pnpm changeset add` — no changeset needed for docs-only changes

@andromia3 andromia3 requested a review from a team as a code owner April 14, 2026 16:22
- 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant