Repository navigation
docs: fix quick-start preview image - #4307
Conversation
|
@matrv is attempting to deploy a commit to the Nitro Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughThis PR updates a single image URL in the Quick Start documentation. The preview image source in ChangesQuick Start Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/1.docs/2.quick-start.md (2)
28-28: 💤 Low valueConsider 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 israw.githubusercontent.comor 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=truequery 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 winUpdate: the preview image link now resolves to the SVG
- The
.../blob/main/.images/preview-dark.svg?raw=trueURL redirects to HTTP 200 and servesimage/svg+xml, so the prior 404 regression for this asset is resolved.- Optional: consider using the direct
raw.githubusercontent.comURL 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
📒 Files selected for processing (1)
docs/1.docs/2.quick-start.md
|
thanks! i hate copilot, in one iteration it fixed issue then forgot all context -_- |
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.
Fixes #4305