Skip to content

⚡ Bolt: Optimize README assets and fix malformed URL - #37

Open
Alex10007 wants to merge 1 commit into
mainfrom
bolt-readme-optimization-3899646490571207842
Open

⚡ Bolt: Optimize README assets and fix malformed URL#37
Alex10007 wants to merge 1 commit into
mainfrom
bolt-readme-optimization-3899646490571207842

Conversation

@Alex10007

@Alex10007 Alex10007 commented Jun 22, 2026

Copy link
Copy Markdown
Owner

💡 What:

  • Converted Markdown image syntax for the header GIF and LinkedIn badge to HTML <img> tags.
  • Added explicit width (1284) and height (908) attributes to the header GIF.
  • Added fetchpriority="high" and style="max-width: 100%; height: auto;" to the header GIF.
  • Added explicit width (91) and height (28) attributes to the LinkedIn badge.
  • Fixed a malformed Medium URL in the project list (Project 4) by replacing %20 with -.
  • Added performance-related HTML comments to README.md.
  • Updated .jules/bolt.md with critical learnings regarding LCP/CLS in documentation.

🎯 Why:

  • Explicit dimensions eliminate Cumulative Layout Shift (CLS) by allowing the browser to reserve space before the assets load.
  • fetchpriority="high" improves Largest Contentful Paint (LCP) by prioritizing the main header GIF, which is the largest content element.
  • Fixing the malformed URL ensures users reach the intended content without 404/403 errors or unnecessary redirects caused by encoded spaces where hyphens are intended.

📊 Impact:

  • Eliminates layout shifting for the top of the README, providing a more stable loading experience.
  • Improves LCP for the main visual element.
  • Restores functionality for the Project 4 link.

🔬 Measurement:

  • Verified image dimensions using binary header parsing.
  • Verified link resolution for the fixed Medium URL.
  • Verified README.md rendering (visual inspection of the raw file).

PR created automatically by Jules for task 3899646490571207842 started by @Alex10007

Summary by CodeRabbit

  • Documentation
    • Added documentation journal entry describing page performance improvements
    • Updated AI projects section image formatting
    • Adjusted LinkedIn badge presentation in documentation
    • Corrected URL in "Machine Learning on Time Series Forecasting" project entry

- Optimize header GIF and LinkedIn badge for LCP/CLS using HTML tags.
- Fix malformed Medium URL in project list.
- Update Bolt journal with learnings.

Co-authored-by: Alex10007 <169648653+Alex10007@users.noreply.github.com>
@google-labs-jules

Copy link
Copy Markdown

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The PR updates README.md to replace Markdown image syntax for the banner GIF and LinkedIn badge with HTML <img> tags that include explicit dimensions, fetchpriority="high", and inline styles. It also fixes a percent-encoded URL slug in the time-series forecasting project link. A dated journal entry is added to .jules/bolt.md documenting this approach.

Changes

README Image Optimization and URL Fix

Layer / File(s) Summary
README HTML img markup and URL fix
README.md
Banner GIF and LinkedIn badge are converted from Markdown image syntax to HTML <img> tags with explicit width/height, fetchpriority="high", and inline style attributes. The Medium link for the "10 Machine Learning Projects on Time Series Forecasting" row has its incorrect %20-encoded time-series slug removed.
Jules bolt journal entry
.jules/bolt.md
Adds a dated section documenting the rationale for using HTML <img> elements with explicit dimensions and high fetch priority to improve LCP/CLS in GitHub-rendered docs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐇 A banner with dimensions clear,
fetchpriority set to "high" right here,
The slug lost its %20 one day,
And CLS and LCP hopped away —
Clean markup makes the README shine! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and concisely summarizes the two main changes: optimizing README assets for web performance (HTML img tags with fetchpriority and explicit dimensions) and fixing a malformed URL in the project list.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch bolt-readme-optimization-3899646490571207842

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

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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.

Inline comments:
In `@README.md`:
- Line 5: The img element displaying the banner GIF with
src="images/Colorful%20Futuristic%20Technology%20Poster.gif" is missing an alt
attribute, which is required for accessibility and SEO. Add a descriptive alt
attribute to this img tag that accurately describes the content of the banner
image, such as something that conveys it's a colorful futuristic technology
poster used as a banner.
- Line 5: The fetchpriority attribute on the img tag with src
"images/Colorful%20Futuristic%20Technology%20Poster.gif" is being stripped by
GitHub's markdown sanitizer and has no effect. Remove the fetchpriority="high"
attribute from this img tag to eliminate the ineffective optimization attempt.
Keep all other attributes (src, width, height, style) intact.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fe0dc345-a43f-40d9-8436-2d14926f1356

📥 Commits

Reviewing files that changed from the base of the PR and between 980f4d0 and bd22e5e.

📒 Files selected for processing (2)
  • .jules/bolt.md
  • README.md

Comment thread README.md
***500 AI Machine learning Deep learning Computer vision NLP Projects with code* !!!**

![](images/Colorful%20Futuristic%20Technology%20Poster.gif)
<img src="images/Colorful%20Futuristic%20Technology%20Poster.gif" width="1284" height="908" fetchpriority="high" style="max-width: 100%; height: auto;"> <!-- ⚡ Bolt Optimization: Improve LCP and eliminate CLS -->

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add missing alt text to the banner GIF for accessibility.

The banner image is missing an alt attribute, which is essential for screen readers and SEO. While the LinkedIn badge on line 7 includes alt="LinkedIn Badge", the primary banner GIF should also have descriptive alt text.

🖼️ Proposed fix to add alt text
-<img src="images/Colorful%20Futuristic%20Technology%20Poster.gif" width="1284" height="908" fetchpriority="high" style="max-width: 100%; height: auto;"> <!-- ⚡ Bolt Optimization: Improve LCP and eliminate CLS -->
+<img src="images/Colorful%20Futuristic%20Technology%20Poster.gif" width="1284" height="908" fetchpriority="high" alt="Colorful Futuristic Technology Poster - AI Projects Showcase" style="max-width: 100%; height: auto;"> <!-- ⚡ Bolt Optimization: Improve LCP and eliminate CLS -->
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 5-5: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 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 `@README.md` at line 5, The img element displaying the banner GIF with
src="images/Colorful%20Futuristic%20Technology%20Poster.gif" is missing an alt
attribute, which is required for accessibility and SEO. Add a descriptive alt
attribute to this img tag that accurately describes the content of the banner
image, such as something that conveys it's a colorful futuristic technology
poster used as a banner.

Source: Linters/SAST tools


⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify GitHub preserves fetchpriority attribute in rendered markdown

# Fetch the README from GitHub and check if fetchpriority attribute is present in raw/rendered output
# This checks both the raw markdown and rendered HTML
echo "Checking raw markdown for fetchpriority attribute..."
git show HEAD:README.md | grep -o 'fetchpriority=[^ >]*' || echo "fetchpriority not found in markdown"

# Check if the attribute would survive GitHub's HTML sanitizer by inspecting common patterns
echo -e "\nChecking for non-standard attributes in HTML img tags..."
git show HEAD:README.md | grep -E '<img[^>]*fetchpriority' || echo "No fetchpriority in HTML context detected"

Repository: Alex10007/500-AI-Machine-learning-Deep-learning-Computer-vision-NLP-Projects-with-code

Length of output: 476


🌐 Web query:

GitHub markdown renderer fetchpriority attribute preservation HTML sanitizer

💡 Result:

The GitHub markdown renderer does not preserve the fetchpriority attribute in user-supplied content [1][2]. GitHub utilizes an aggressive HTML sanitization pipeline for all user-rendered content to prevent injection attacks and ensure security [1][3]. This pipeline operates on an explicit whitelist basis, meaning only pre-approved HTML tags and attributes are permitted [2][4]. The fetchpriority attribute (used to influence resource loading priority, such as for images or scripts) is not included in the standard GitHub HTML sanitizer whitelist [2][5][6]. Consequently, if you include a fetchpriority attribute within an HTML tag (e.g., ) in a GitHub-rendered markdown file, issue comment, or PR description, the attribute will be stripped by the sanitization filter during the rendering process [1][2]. This behavior is a deliberate security measure and is consistent with the broader "Safe Outputs" requirement that mandates strict sanitization for all user-facing content [7].

Citations:


🌐 Web query:

fetchpriority HTML attribute standard MDN web specification

💡 Result:

The fetchpriority attribute is a standard HTML attribute defined in the WHATWG HTML Standard [1][2][3]. It allows developers to provide a hint to the browser regarding the relative priority of fetching a resource, which can help optimize performance and Core Web Vitals by influencing the loading order of elements [4][5]. Key details of the fetchpriority attribute include: Elements: It can be applied to img, link, script, and iframe elements [4][2]. Values: high: Suggests that the resource has a higher priority and should be fetched sooner [4][5]. low: Suggests that the resource has a lower priority and should be fetched later [4][5]. auto: The default value, indicating no preference and leaving priority decisions to the browser's internal heuristics [4][6]. Functionality: The attribute acts as a hint rather than a strict command; the browser's actual loading behavior depends on its own internal priority logic [4][5]. It is intended to be used sparingly, as misuse can potentially degrade performance [4][6]. In addition to the HTML content attribute, the fetchPriority property is available via the DOM API for the corresponding elements (e.g., HTMLImageElement.fetchPriority), reflecting the value of the attribute in JavaScript [7]. The concept is also supported in the Fetch API as a priority property within RequestInit [3].

Citations:


Remove the fetchpriority attribute—GitHub's markdown sanitizer strips it.

The fetchpriority attribute is a standard HTML feature, but GitHub's markdown renderer does not preserve it. GitHub uses an explicit allowlist-based HTML sanitizer that strips non-whitelisted attributes, including fetchpriority, from all user-rendered content. This means the optimization will not work when the README is viewed on GitHub, making the attribute ineffective and misleading.

Either remove the attribute or use an alternative optimization that GitHub's renderer preserves.

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 5-5: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 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 `@README.md` at line 5, The fetchpriority attribute on the img tag with src
"images/Colorful%20Futuristic%20Technology%20Poster.gif" is being stripped by
GitHub's markdown sanitizer and has no effect. Remove the fetchpriority="high"
attribute from this img tag to eliminate the ineffective optimization attempt.
Keep all other attributes (src, width, height, style) intact.

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.

1 participant