-
-
Notifications
You must be signed in to change notification settings - Fork 967
Fix broken image link in README.md #4876
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
WalkthroughUpdated the documentation image source URL path in README.md from the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~1 minute
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
116-116: Images should have alternate text (alt text)
(MD045, no-alt-text)
|
|
||
| <p float="left" align="middle"> | ||
| <img src="https://docs.netbird.io/docs-static/img/architecture/high-level-dia.png" width="700"/> | ||
| <img src="https://docs.netbird.io/docs-static/img/about-netbird/high-level-dia.png" width="700"/> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion | 🟠 Major
Add alt text to image for accessibility.
The URL correction is good and fixes the broken link. However, the image is missing descriptive alt text, which is required for accessibility and flagged by markdown linting (MD045).
Apply this diff to add appropriate alt text:
- <img src="https://docs.netbird.io/docs-static/img/about-netbird/high-level-dia.png" width="700"/>
+ <img src="https://docs.netbird.io/docs-static/img/about-netbird/high-level-dia.png" width="700" alt="NetBird high-level architecture diagram"/>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <img src="https://docs.netbird.io/docs-static/img/about-netbird/high-level-dia.png" width="700"/> | |
| <img src="https://docs.netbird.io/docs-static/img/about-netbird/high-level-dia.png" width="700" alt="NetBird high-level architecture diagram"/> |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
116-116: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In README.md around line 116 the image tag lacks alt text which fails
accessibility/MD045; update the <img> tag to include a concise, descriptive alt
attribute (for example: alt="High-level NetBird architecture diagram") while
keeping the existing src and width attributes so the image remains the same
visually but is accessible to screen readers and passes linting.
|



Describe your changes
Issue ticket number and link
Stack
Checklist
Documentation
Select exactly one:
This is a simple fix to the repository readme. An image path (
https://docs.netbird.io/docs-static/img/architecture/high-level-dia.png) currently 404s.I searched the filename in the docs repository, and found that the image had been moved from
architecture/to theabout-netbird/directory. The Wayback Machine confirms that this image is the same as the relocated one.This PR simply updates the now-broken image path.
Docs PR URL (required if "docs added" is checked)
Paste the PR link from https://github.com/netbirdio/docs here:
Quick link to updated readme preview
Summary by CodeRabbit
Release Notes
✏️ Tip: You can customize this high-level summary in your review settings.