Skip to content

docs: fix quick-start preview image - #4307

Merged
pi0 merged 1 commit into
nitrojs:mainfrom
matrv:main
Jun 3, 2026
Merged

pi0 merged 1 commit into
nitrojs:mainfrom
matrv:main

Conversation

@matrv

@matrv matrv commented Jun 3, 2026 •

Copy link
Copy Markdown
Contributor

in #4305 the Copilot Agent added the screenshot from the issue to the docs instead of the actual preview image.

This PR sets the correct preview image.

BEFORE AFTER
Image image

Fixes #4305

@matrv
matrv requested a review from pi0 as a code owner June 3, 2026 14:28
@vercel

vercel Bot commented Jun 3, 2026

Copy link
Copy Markdown

@matrv is attempting to deploy a commit to the Nitro Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jun 3, 2026 •

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

This PR updates a single image URL in the Quick Start documentation. The preview image source in docs/1.docs/2.quick-start.md was changed from a user-attachments URL to Nitro's create-nitro-app repository preview-dark.svg asset.

Changes

Quick Start Documentation

Layer / File(s) Summary
Quick Start preview image URL update
docs/1.docs/2.quick-start.md
The preview image source in the "Preview" details block switched from a user-attachments GIF/image URL to Nitro's create-nitro-app repository dark preview asset using ?raw=true query parameter.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

  • #4305: The linked issue describes fixing the quick-start preview image to restore the screenshot in the Create a Nitro project section, which this PR directly implements by updating the image URL source.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: fix quick-start preview image' follows conventional commits format with a 'docs' type prefix and clearly describes the change being made.
Linked Issues check ✅ Passed The PR directly addresses all objectives from issue #4305: replacing the broken preview image source and simplifying to a single image instead of light/dark SVGs.
Out of Scope Changes check ✅ Passed The changes are narrowly scoped to fixing the preview image in quick-start documentation as required by issue #4305, with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description clearly explains the issue being fixed—replacing an incorrect screenshot with the correct preview image—and directly relates to the changeset in the Quick Start documentation.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (2)
docs/1.docs/2.quick-start.md (2)

28-28: 💤 Low value

Consider using the standard raw content URL format.

The current URL uses /blob/main/...?raw=true, which works but is unconventional. GitHub's standard format for raw content is raw.githubusercontent.com or the /raw/ path.

📝 Suggested URL format
-    <img src="https://github.com/nitrojs/create-nitro-app/blob/main/.images/preview-dark.svg?raw=true" alt="Preview" style="max-width:100%;height:auto;display:block;" />
+    <img src="https://raw.githubusercontent.com/nitrojs/create-nitro-app/main/.images/preview-dark.svg" alt="Preview" style="max-width:100%;height:auto;display:block;" />

Alternatively, using GitHub's /raw/ path:

-    <img src="https://github.com/nitrojs/create-nitro-app/blob/main/.images/preview-dark.svg?raw=true" alt="Preview" style="max-width:100%;height:auto;display:block;" />
+    <img src="https://github.com/nitrojs/create-nitro-app/raw/main/.images/preview-dark.svg" alt="Preview" style="max-width:100%;height:auto;display:block;" />

Both formats are more standard and don't require the ?raw=true query parameter.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/1.docs/2.quick-start.md` at line 28, Update the image src to use
GitHub's standard raw content URL instead of the blob+?raw=true form: locate the
<img> tag's src attribute (currently pointing to
"https://github.com/.../blob/main/.images/preview-dark.svg?raw=true") and
replace it with either the raw.githubusercontent.com host format or the /raw/
path format so the image loads using the conventional raw URL (e.g., use
raw.githubusercontent.com/OWNER/REPO/main/.images/preview-dark.svg or
github.com/OWNER/REPO/raw/main/.images/preview-dark.svg).

28-28: ⚡ Quick win

Update: the preview image link now resolves to the SVG

  • The .../blob/main/.images/preview-dark.svg?raw=true URL redirects to HTTP 200 and serves image/svg+xml, so the prior 404 regression for this asset is resolved.
  • Optional: consider using the direct raw.githubusercontent.com URL for consistency (avoid relying on GitHub blob redirect behavior).
  • Dark-only (preview-dark.svg) may be a light-mode UX tradeoff; keep only if the single-image intent is deliberate (per #4305).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/1.docs/2.quick-start.md` at line 28, The preview image currently uses a
GitHub blob URL that relies on redirect behavior; update the <img> src to the
direct raw.githubusercontent.com URL for the file (replace the
blob/.../preview-dark.svg?raw=true link with the
raw.githubusercontent.com/raw/<repo>/<path>/preview-dark.svg) to avoid
redirects, and confirm whether using the dark-only asset (preview-dark.svg) is
intentional—if not, replace with a neutral or dual-mode image (e.g.,
preview.svg) so the docs show correctly across light/dark modes.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/1.docs/2.quick-start.md`:
- Line 28: Update the image src to use GitHub's standard raw content URL instead
of the blob+?raw=true form: locate the <img> tag's src attribute (currently
pointing to
"https://github.com/.../blob/main/.images/preview-dark.svg?raw=true") and
replace it with either the raw.githubusercontent.com host format or the /raw/
path format so the image loads using the conventional raw URL (e.g., use
raw.githubusercontent.com/OWNER/REPO/main/.images/preview-dark.svg or
github.com/OWNER/REPO/raw/main/.images/preview-dark.svg).
- Line 28: The preview image currently uses a GitHub blob URL that relies on
redirect behavior; update the <img> src to the direct raw.githubusercontent.com
URL for the file (replace the blob/.../preview-dark.svg?raw=true link with the
raw.githubusercontent.com/raw/<repo>/<path>/preview-dark.svg) to avoid
redirects, and confirm whether using the dark-only asset (preview-dark.svg) is
intentional—if not, replace with a neutral or dual-mode image (e.g.,
preview.svg) so the docs show correctly across light/dark modes.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a7974bdc-3438-48d1-85b2-cdf8c94a4a21

📥 Commits

Reviewing files that changed from the base of the PR and between f0cb358 and 72873c5.

📒 Files selected for processing (1)
  • docs/1.docs/2.quick-start.md

@pi0

pi0 commented Jun 3, 2026

Copy link
Copy Markdown
Member

thanks! i hate copilot, in one iteration it fixed issue then forgot all context -_-

@pi0
pi0 merged commit 3b1bca3 into nitrojs:main Jun 3, 2026
8 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants