fix: replace Imgur images with local alternatives #189
Conversation
Deploying spicetify-docs with
|
| Latest commit: |
6a9822b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c92983c7.spicetify-docs.pages.dev |
| Branch Preview URL: | https://megathink.spicetify-docs.pages.dev |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 69.8%, saving 3.3 MB.
|
WalkthroughReplaced external Imgur image URLs with local repository image paths in multiple documentation files; updated CI image-compression workflow triggers and action version; added a new Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ 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.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/advanced-usage/extensions.md (1)
93-93: Fix hyphenated compound adjectives in documentation text.LanguageTool flagged several instances where compound adjectives before nouns should use hyphens: "right click" → "right-click", "double click" → "double-click". This improves formal documentation clarity.
Apply this diff to fix the hyphenation issues:
- Auto skip explicit tracks. Toggle option is in Profile menu (top right button). + Auto skip explicit tracks. Toggle option is in Profile menu (top-right button). - Full App Display: Minimal album cover art display with beautiful blur effect background. Activating button located in top bar. While in display mode, double click anywhere to exit. Right click anywhere to open setting menu. + Full App Display: Minimal album cover art display with beautiful blur effect background. Activating button located in top bar. While in display mode, double-click anywhere to exit. Right-click anywhere to open setting menu. - Have easy access to a pop-up window with the current song's lyrics. Click at microphone icon on top bar to open lyrics windows. Right click at the same icon to open config menu to customize looks and lyrics providers priorities. + Have easy access to a pop-up window with the current song's lyrics. Click at microphone icon on top bar to open lyrics windows. Right-click at the same icon to open config menu to customize looks and lyrics providers priorities. - This extension will append a Throw to Trashbin option in tracks and artists link right click menu. + This extension will append a Throw to Trashbin option in tracks and artists link right-click menu.Also applies to: 101-101, 131-131, 145-145
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (19)
static/images/apps/lyrics-plus.pngis excluded by!**/*.pngstatic/images/apps/new-releases.pngis excluded by!**/*.pngstatic/images/apps/reddit.pngis excluded by!**/*.pngstatic/images/development/js-modules-1.pngis excluded by!**/*.pngstatic/images/development/js-modules-2.pngis excluded by!**/*.pngstatic/images/extensions/bookmark.pngis excluded by!**/*.pngstatic/images/extensions/christian-demo.pngis excluded by!**/*.pngstatic/images/extensions/dj-demo.pngis excluded by!**/*.pngstatic/images/extensions/full-app-display.pngis excluded by!**/*.pngstatic/images/extensions/keyboard-demo.pngis excluded by!**/*.pngstatic/images/extensions/loopy-loop.pngis excluded by!**/*.pngstatic/images/extensions/popup-lyrics.pngis excluded by!**/*.pngstatic/images/extensions/queue-all-demo.pngis excluded by!**/*.pngstatic/images/extensions/shuffle.pngis excluded by!**/*.pngstatic/images/extensions/trash.pngis excluded by!**/*.pngstatic/images/faq/mxm1.pngis excluded by!**/*.pngstatic/images/faq/mxm2.pngis excluded by!**/*.pngstatic/images/faq/mxm3.pngis excluded by!**/*.pngstatic/images/faq/mxm4.pngis excluded by!**/*.png
📒 Files selected for processing (4)
docs/advanced-usage/custom-apps.md(3 hunks)docs/advanced-usage/extensions.md(4 hunks)docs/development/js-modules.md(1 hunks)docs/faq.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/advanced-usage/extensions.md
[grammar] ~93-~93: Use a hyphen to join words.
Context: ...Filename:* autoSkipExplicit.js Auto skip explicit tracks. Toggle option is i...
(QB_NEW_EN_HYPHEN)
[grammar] ~101-~101: Use a hyphen to join words.
Context: ...n top bar. While in display mode, double click anywhere to exit. Right click anyw...
(QB_NEW_EN_HYPHEN)
[grammar] ~101-~101: Use a hyphen to join words.
Context: ...de, double click anywhere to exit. Right click anywhere to open setting menu. ![...
(QB_NEW_EN_HYPHEN)
[grammar] ~131-~131: Use a hyphen to join words.
Context: ...on top bar to open lyrics windows. Right click at the same icon to open config me...
(QB_NEW_EN_HYPHEN)
[grammar] ~145-~145: Use a hyphen to join words.
Context: ... option in tracks and artists link right click menu. 
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (4)
docs/advanced-usage/custom-apps.md (1)
76-76: All custom app images are properly present.The three image files referenced in the custom-apps documentation (reddit.png, new-releases.png, lyrics-plus.png) exist in
static/images/apps/and are correctly linked in the markdown at lines 76, 89, and 104.docs/development/js-modules.md (1)
24-24: Image files verified and present.Both image references in docs/development/js-modules.md (lines 24, 28) correctly point to existing PNG files in the repository:
static/images/development/js-modules-1.pngandstatic/images/development/js-modules-2.png.docs/faq.md (1)
72-72: All FAQ image files are present and correctly referenced.The four Musixmatch token instruction images (
mxm1.pngthroughmxm4.png) exist instatic/images/faq/and are properly referenced in the markdown at lines 72, 76, 80, and 90.docs/advanced-usage/extensions.md (1)
87-87: All referenced image files exist in the repository.The image paths at lines 87, 95, 103, 117, 125, 133, 140, 147, 176, and 192 are correctly formatted and all corresponding PNG files are present in
static/images/extensions/.
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 10.7%, saving 111.3 KB.
7 images did not require optimisation. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 9.2%, saving 40.6 KB.
14 images did not require optimisation. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 7.2%, saving 14.3 KB.
17 images did not require optimisation. |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 7.6%, saving 13.2 KB.
18 images did not require optimisation. |
5435e82 to
e9ee414
Compare
- Download 19 Imgur-hosted images to static/images/ - Update markdown references to use local paths - Add mise.toml for Node.js 24 and Bun version management - Fix compress_images workflow to only run on PR open Fixes #188
e9ee414 to
6a9822b
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
mise.toml (1)
1-3: Consider pinning the Bun version.The Node version is pinned to "24", but Bun uses "latest", which may lead to non-deterministic builds across different setup times. If reproducibility is important, consider pinning Bun to a specific version.
docs/advanced-usage/extensions.md (1)
101-101: Apply hyphens to compound modifiers "click" phrases.Several lines use unhyphenated click phrases that should be hyphenated per English grammar conventions:
- Line 101: "double click" → "double-click" (appears twice on this line)
- Line 131: "Right click" → "right-click"
- Line 145: "right click" → "right-click"
Apply these diffs to fix the grammar:
- While in display mode, double click anywhere to exit. Right click anywhere to open setting menu. + While in display mode, double-click anywhere to exit. Right-click anywhere to open setting menu.- Have easy access to a pop-up window with the current song's lyrics. Click at microphone icon on top bar to open lyrics windows. Right click at the same icon to open config menu to customize looks and lyrics providers priorities. + Have easy access to a pop-up window with the current song's lyrics. Click at microphone icon on top bar to open lyrics windows. Right-click at the same icon to open config menu to customize looks and lyrics providers priorities.- This extension will append a Throw to Trashbin option in tracks and artists link right click menu. + This extension will append a Throw to Trashbin option in tracks and artists link right-click menu.Also applies to: 131-131, 145-145
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (20)
bun.lockis excluded by!**/*.lockstatic/images/apps/lyrics-plus.pngis excluded by!**/*.pngstatic/images/apps/new-releases.pngis excluded by!**/*.pngstatic/images/apps/reddit.pngis excluded by!**/*.pngstatic/images/development/js-modules-1.pngis excluded by!**/*.pngstatic/images/development/js-modules-2.pngis excluded by!**/*.pngstatic/images/extensions/bookmark.pngis excluded by!**/*.pngstatic/images/extensions/christian-demo.pngis excluded by!**/*.pngstatic/images/extensions/dj-demo.pngis excluded by!**/*.pngstatic/images/extensions/full-app-display.pngis excluded by!**/*.pngstatic/images/extensions/keyboard-demo.pngis excluded by!**/*.pngstatic/images/extensions/loopy-loop.pngis excluded by!**/*.pngstatic/images/extensions/popup-lyrics.pngis excluded by!**/*.pngstatic/images/extensions/queue-all-demo.pngis excluded by!**/*.pngstatic/images/extensions/shuffle.pngis excluded by!**/*.pngstatic/images/extensions/trash.pngis excluded by!**/*.pngstatic/images/faq/mxm1.pngis excluded by!**/*.pngstatic/images/faq/mxm2.pngis excluded by!**/*.pngstatic/images/faq/mxm3.pngis excluded by!**/*.pngstatic/images/faq/mxm4.pngis excluded by!**/*.png
📒 Files selected for processing (6)
.github/workflows/compress_images.yml(3 hunks)docs/advanced-usage/custom-apps.md(3 hunks)docs/advanced-usage/extensions.md(4 hunks)docs/development/js-modules.md(1 hunks)docs/faq.md(2 hunks)mise.toml(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/advanced-usage/custom-apps.md
- docs/development/js-modules.md
- docs/faq.md
🧰 Additional context used
🪛 LanguageTool
docs/advanced-usage/extensions.md
[grammar] ~93-~93: Use a hyphen to join words.
Context: ...Filename:* autoSkipExplicit.js Auto skip explicit tracks. Toggle option is i...
(QB_NEW_EN_HYPHEN)
[grammar] ~101-~101: Use a hyphen to join words.
Context: ...n top bar. While in display mode, double click anywhere to exit. Right click anyw...
(QB_NEW_EN_HYPHEN)
[grammar] ~101-~101: Use a hyphen to join words.
Context: ...de, double click anywhere to exit. Right click anywhere to open setting menu. ![...
(QB_NEW_EN_HYPHEN)
[grammar] ~131-~131: Use a hyphen to join words.
Context: ...on top bar to open lyrics windows. Right click at the same icon to open config me...
(QB_NEW_EN_HYPHEN)
[grammar] ~145-~145: Use a hyphen to join words.
Context: ... option in tracks and artists link right click menu. 
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (5)
docs/advanced-usage/extensions.md (2)
87-147: Image URL replacements look good.All 10 extension demo images have been consistently replaced with local paths under
/images/extensions/. The relative path structure is correct and follows the PR's organization scheme.Also applies to: 176-192
184-184: Line 184: External URL inconsistent with other images; local replacement image missing.This image reference uses an external GitHub URL while all other extensions reference local paths (
/images/extensions/{filename}.png). However, the suggested local replacement (/images/extensions/new-release.png) does not exist in the repository—the local extensions directory lacks this file. Additionally, this is a GitHub user URL rather than an Imgur link, which differs from the PR's stated scope of replacing Imgur images. Clarify whether: (1) this image needs to be downloaded and added to the local directory, or (2) the external reference was intentionally preserved for this extension..github/workflows/compress_images.yml (3)
3-4: Verify the intent of restricting the trigger toopenedevents only.The workflow previously ran on all pull request events (or at least
openedandsynchronize), but now it's restricted totypes: [opened]only. This means the image compression workflow won't run when new commits are pushed to an existing PR—it will only run when the PR is first created.Please confirm whether this is intentional (e.g., for cost control) or if it should also include
synchronizeto re-run when the PR is updated:types: [opened, synchronize]
6-9: Good improvements to the workflow.The expansion of watched file patterns to include
**.pngand**.webpaligns well with the addition of local PNG images in this PR. The upgrade fromactions/checkout@v2toactions/checkout@v4is a solid maintenance improvement, bringing in performance fixes and newer features.Also applies to: 18-18
21-28: ThecompressOnlyparameter is valid and properly implemented.The
compressOnly: trueparameter is a supported Boolean input forcalibreapp/image-actionsthat performs image optimization without committing changes or posting summary comments—appropriate for workflows that handle commits separately.
Fixes #188 by replacing all 19 Imgur-hosted images with locally-hosted versions. This ensures documentation is accessible to users in regions where Imgur is blocked, including the UK.
Images organized in
static/images/by category:faq/- 4 Musixmatch token imagesextensions/- 10 extension demo imagesapps/- 3 custom app demo imagesdevelopment/- 2 JavaScript module imagesAll markdown references updated to use relative paths instead of Imgur URLs.
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.