Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @NHLOCAL, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request addresses an issue where images on the docs/index.html page might not be loading correctly by converting their relative paths to absolute URLs. This change ensures that the favicon, hero logo, and a screenshot are consistently displayed, regardless of how the documentation page is accessed.
Highlights
- Image Path Correction: Updated all relative image paths within
docs/index.htmlto use absolute URLs pointing directly to the GitHub repository's raw content. This ensures images load correctly, especially when the page is viewed outside the immediate repository context or from different base URLs.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request updates image paths in docs/index.html from relative paths (e.g., ../assets/image.png) to absolute URLs pointing to raw.githubusercontent.com. This change likely resolves issues where images were not displaying correctly, possibly due to the GitHub Pages serving configuration and the original asset locations relative to the docs folder.
My review focuses on the maintainability implications of using these absolute GitHub raw content URLs. While this fixes the immediate issue, it makes the image links brittle—they will break if the repository owner, name, or default branch (main) changes. I've provided medium severity comments for each modified image path, suggesting a more robust and conventional alternative: restructuring assets to be within the docs folder (e.g., by creating docs/assets/ and placing images there). This would allow the use of simple relative paths (e.g., assets/image.png), making the site more self-contained, portable, and easier to maintain in the long run. The code suggestions illustrate what these relative paths would look like, assuming such a restructuring of the assets directory.
| <title>שמור וזכור - מעקב לימוד תורה</title> | ||
|
|
||
| <link rel="icon" type="image/png" href="../assets/favicon.png"> | ||
| <link rel="icon" type="image/png" href="https://raw.githubusercontent.com/NHLOCAL/Shamor-Zachor/main/assets/favicon.png"> |
There was a problem hiding this comment.
Using the full raw.githubusercontent.com URL makes this link dependent on the specific GitHub repository structure (owner, repo name, main branch) and introduces an external dependency for what is likely a local asset. This can lead to broken links if the repository details (e.g., name, owner) or the default branch name changes.
For improved maintainability and to keep the site self-contained, it's generally recommended to serve assets from within the docs directory when using GitHub Pages. If the assets folder were moved to docs/assets/, this path could be relative, like so:
<link rel="icon" type="image/png" href="assets/favicon.png">This makes your site more portable and robust. Please consider if restructuring your assets into the docs folder (e.g., creating docs/assets/ and moving images there) is feasible for a cleaner setup.
| <link rel="icon" type="image/png" href="https://raw.githubusercontent.com/NHLOCAL/Shamor-Zachor/main/assets/favicon.png"> | |
| <link rel="icon" type="image/png" href="assets/favicon.png"> |
| <header class="hero"> | ||
| <div class="container"> | ||
| <img src="../assets/favicon.png" alt="לוגו שמור וזכור" class="hero-logo"> | ||
| <img src="https://raw.githubusercontent.com/NHLOCAL/Shamor-Zachor/main/assets/favicon.png" alt="לוגו שמור וזכור" class="hero-logo"> |
There was a problem hiding this comment.
Similar to the favicon link, this absolute URL to raw.githubusercontent.com for the hero logo makes the image source brittle. It's dependent on the current GitHub repository structure (owner, repo name) and the main branch name remaining unchanged.
If the assets folder were located at docs/assets/, a more maintainable relative path could be used, for example:
<img src="assets/favicon.png" alt="לוגו שמור וזכור" class="hero-logo">This approach makes the website more portable and less prone to breaking if repository details change. Consider moving assets into the docs folder to enable such relative paths.
| <img src="https://raw.githubusercontent.com/NHLOCAL/Shamor-Zachor/main/assets/favicon.png" alt="לוגו שמור וזכור" class="hero-logo"> | |
| <img src="assets/favicon.png" alt="לוגו שמור וזכור" class="hero-logo"> |
| <h2><i class="fa-solid fa-image"></i> מבט על הממשק</h2> | ||
| <div class="screenshot-wrapper"> | ||
| <img src="../assets/screen.png" alt="צילום מסך של תוכנת שמור וזכור"> | ||
| <img src="https://raw.githubusercontent.com/NHLOCAL/Shamor-Zachor/main/assets/screen.png" alt="צילום מסך של תוכנת שמור וזכור"> |
There was a problem hiding this comment.
This image path for the screenshot also uses an absolute raw.githubusercontent.com URL. This carries the same maintainability concerns mentioned for the other images: a strong dependency on the GitHub repository's current owner, name, and main branch, and an external dependency for a site asset.
If the assets folder were structured as docs/assets/, you could use a relative path like assets/screen.png:
<img src="assets/screen.png" alt="צילום מסך של תוכנת שמור וזכור">This would make the site more robust to changes in the repository's hosting or structure and is generally preferred for static sites.
| <img src="https://raw.githubusercontent.com/NHLOCAL/Shamor-Zachor/main/assets/screen.png" alt="צילום מסך של תוכנת שמור וזכור"> | |
| <img src="assets/screen.png" alt="צילום מסך של תוכנת שמור וזכור"> |
No description provided.