Refactor README.md for better structure and visuals #662
Conversation
Updated README.md to enhance formatting, improve clarity, and add new logos.
|
🎉 Welcome @KUL236!
We appreciate your contribution! 🚀 |
WalkthroughThe README.md file underwent comprehensive reformatting and stylistic enhancement, introducing rich HTML blocks, emojis, and improved visual structure. Changes include reorganized headers with dual logos, reworked sections with bold styling and horizontal dividers, enhanced feature descriptions with enumerated lists, and updated styling for maintainers, contribution guidelines, and license information. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (2)
README.md (2)
21-55: Avoidstyle=/target="_blank"in GitHub README HTML; prefer minimal, portable markup.GitHub may strip or ignore inline styles and
target="_blank"; consider removing them to reduce “looks different locally vs on GitHub” drift.-<div align="center" style="text-align:center;"> +<div align="center"> ... - <a href="https://appwrite.io" target="_blank"> + <a href="https://appwrite.io"> ... - <a href="https://livekit.io" target="_blank"> + <a href="https://livekit.io">
17-17: (Optional) Hyphenate “Open-source” if used as a compound adjective.E.g., “an open-source social voice platform” reads more standard in prose.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: M4dhav
Repo: AOSSIE-Org/Resonate PR: 510
File: .github/workflows/build_and_deploy.yml:31-36
Timestamp: 2025-08-31T16:18:53.594Z
Learning: For the AOSSIE-Org/Resonate project, build system requirements like Java version setup are considered separate from dependency update PRs and should be handled in dedicated PRs focused on build system improvements.
🪛 LanguageTool
README.md
[uncategorized] ~17-~17: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ..." /> # 🎙️ Resonate – An Open Source Social Voice Platform <div ali...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.18.1)
README.md
126-126: Images should have alternate text (alt text)
(MD045, no-alt-text)
126-126: Images should have alternate text (alt text)
(MD045, no-alt-text)
126-126: Images should have alternate text (alt text)
(MD045, no-alt-text)
130-130: Images should have alternate text (alt text)
(MD045, no-alt-text)
130-130: Images should have alternate text (alt text)
(MD045, no-alt-text)
130-130: Images should have alternate text (alt text)
(MD045, no-alt-text)
134-134: Images should have alternate text (alt text)
(MD045, no-alt-text)
134-134: Images should have alternate text (alt text)
(MD045, no-alt-text)
134-134: Images should have alternate text (alt text)
(MD045, no-alt-text)
158-158: Bare URL used
(MD034, no-bare-urls)
167-167: Images should have alternate text (alt text)
(MD045, no-alt-text)
170-170: Images should have alternate text (alt text)
(MD045, no-alt-text)
173-173: Images should have alternate text (alt text)
(MD045, no-alt-text)
176-176: Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (1)
README.md (1)
64-87: Features/tech sections are clear; keep list formatting consistent.The separation with
---and the numbered lists read well and scan quickly.
| <div align="center"> | ||
| <span> | ||
| <img src="https://github.com/ShivamMenda/Resonate/assets/74780977/ca9e88d2-f4ca-4d8c-8a8a-289286b91e54" alt="Resonate logo" width="150" height="auto" /> | ||
| <img src="assets/images/aossie_logo.png" alt="Resonate logo" width="150" height="auto" /> | ||
| </span> | ||
|
|
||
| # :microphone: Resonate - An Open Source Social Voice Platform | ||
| <span> | ||
| <img | ||
| src="https://github.com/ShivamMenda/Resonate/assets/74780977/ca9e88d2-f4ca-4d8c-8a8a-289286b91e54" | ||
| alt="Resonate logo" | ||
| width="150" | ||
| height="auto" | ||
| /> | ||
| <img | ||
| src="assets/images/aossie_logo.png" | ||
| alt="AOSSIE logo" | ||
| width="150" | ||
| height="auto" | ||
| /> | ||
| </span> | ||
|
|
||
| # 🎙️ Resonate – An Open Source Social Voice Platform | ||
|
|
||
| </div> | ||
| <div align="center" style="text-align:center;"> | ||
| <span> | ||
| <a href="https://appwrite.io" target="_blank"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" align="center" srcset="https://github.com/appwrite/website/blob/main/static/images/logos/appwrite.svg" | ||
| alt="Appwrite Logo" width="200"> | ||
| <img alt="Appwrite Logo" align="center" src="https://github.com/appwrite/website/blob/main/static/images/logos/appwrite-light.svg" alt="Appwrite Logo" | ||
| width="200"> | ||
| </picture> | ||
| </a> | ||
| | ||
| <a href="https://livekit.io" target="_blank"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" align="center" srcset="https://github.com/AKASHANGADII/Resonate/assets/81625153/87bb173f-d5b0-4386-b9ca-6e69cd53578f" alt="Livekit Logo" width="140" height="30"> | ||
| <img alt="Livekit Logo" align="center" src="https://github.com/AKASHANGADII/Resonate/assets/81625153/1466de84-d00e-4db7-9b51-a99f3c1997ff" width="140" | ||
| height="30"> | ||
| </picture> | ||
| </a> | ||
| </span> | ||
|
|
||
| <div align="center" style="text-align:center;"> | ||
| <span> | ||
| <a href="https://appwrite.io" target="_blank"> | ||
| <picture> | ||
| <source | ||
| media="(prefers-color-scheme: dark)" | ||
| srcset="https://github.com/appwrite/website/blob/main/static/images/logos/appwrite.svg" | ||
| /> | ||
| <img | ||
| src="https://github.com/appwrite/website/blob/main/static/images/logos/appwrite-light.svg" | ||
| alt="Appwrite Logo" | ||
| width="200" | ||
| /> | ||
| </picture> | ||
| </a> | ||
| | ||
| <a href="https://livekit.io" target="_blank"> | ||
| <picture> | ||
| <source | ||
| media="(prefers-color-scheme: dark)" | ||
| srcset="https://github.com/AKASHANGADII/Resonate/assets/81625153/87bb173f-d5b0-4386-b9ca-6e69cd53578f" | ||
| /> | ||
| <img | ||
| src="https://github.com/AKASHANGADII/Resonate/assets/81625153/1466de84-d00e-4db7-9b51-a99f3c1997ff" | ||
| alt="LiveKit Logo" | ||
| width="140" | ||
| height="30" | ||
| /> | ||
| </picture> | ||
| </a> | ||
| </span> | ||
| </div> | ||
| <br> | ||
| <br> | ||
|
|
||
| <br/> | ||
|
|
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
GitHub README image rendering github.com blob vs raw.githubusercontent.com
💡 Result:
Short answer
- Use raw.githubusercontent.com (or a repository-relative path) for images in README. github.com/.../blob/... links point to an HTML GitHub page, not the image bytes, so they usually won’t render inline. [1][2]
Why
- github.com/.../blob/... serves a GitHub web page that displays the file; that URL returns HTML, not the raw file bytes. Browsers won’t treat that URL as an image source. [1][2]
- raw.githubusercontent.com serves the raw file contents (image bytes) and is the correct host for embedding images. Relative paths in the repo README also work and are preferred for portability. [1][3]
Practical notes / gotchas
- Adding ?raw=true to a /blob/ URL causes GitHub to redirect to the raw URL (useful in some contexts). For private repos the raw URL may include an access token. [2]
- SVGs can have special rendering/security restrictions (and may be blocked in some browsers); prefer PNG/JPG for predictable rendering. [1]
- If README images randomly break, check paths, branch name, caching, and whether GitHub changed how it resolves relative links (there have been intermittent issues). [4]
References
- GitHub docs — working with non‑code files / image rendering. [1]
- Stack Overflow discussion about using /blob vs raw and ?raw=true behavior. [2]
- Gist / GitHub guidance on assets and raw URLs (raw.githubusercontent.com and user-images host). [3]
- GitHub Community discussion on README image path/resolution issues. [4]
Fix Appwrite logo URLs: github.com/.../blob/... won't render as images in README.
Those URLs point to GitHub's HTML page, not the raw image bytes. Use raw.githubusercontent.com instead:
- srcset="https://github.com/appwrite/website/blob/main/static/images/logos/appwrite.svg"
+ srcset="https://raw.githubusercontent.com/appwrite/website/main/static/images/logos/appwrite.svg"
...
- src="https://github.com/appwrite/website/blob/main/static/images/logos/appwrite-light.svg"
+ src="https://raw.githubusercontent.com/appwrite/website/main/static/images/logos/appwrite-light.svg"🧰 Tools
🪛 LanguageTool
[uncategorized] ~17-~17: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ..." /> # 🎙️ Resonate – An Open Source Social Voice Platform <div ali...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🤖 Prompt for AI Agents
In README.md around lines 1 to 55, the image src/srcset URLs use
github.com/.../blob/... HTML page URLs which won't render as raw images; replace
those with raw.githubusercontent.com links (or relative repository paths)
pointing to the actual image file bytes and update both src and srcset
attributes to use the correct raw URL (including correct branch/path and https),
ensuring external images use raw.githubusercontent.com and local assets use
relative paths so the images render in the README.
| ## 🍀 Getting Started | ||
|
|
||
| We offer a guide for walking you through setting up the entire project, including a script that automates the set up of the backend environment for you. | ||
| Please go through and strictly follow the [Onboarding Guide](https://github.com/AOSSIE-Org/Resonate/blob/master/ONBOARDING.md) for setting up the project for development and further contribution | ||
| Resonate integrates multiple platforms such as Appwrite and LiveKit, so initial setup can be challenging. | ||
|
|
||
| We provide a complete onboarding guide, including scripts to automate backend setup. | ||
| Please strictly follow the | ||
| [Onboarding Guide](https://github.com/AOSSIE-Org/Resonate/blob/master/ONBOARDING.md) | ||
| for development and contribution setup. | ||
|
|
||
| --- |
There was a problem hiding this comment.
Branch/link consistency: README links use master, but contributing says target dev.
This is confusing for newcomers and can become incorrect if the default branch changes. Either:
- update the text to match the actual target branch, or
- change the hardcoded links to a branch-agnostic form.
Example (if master is correct):
-Contributions are highly appreciated and welcome (please target the `dev` branch).
+Contributions are highly appreciated and welcome (please target the `master` branch).Or (branch-agnostic for docs):
-[Onboarding Guide](https://github.com/AOSSIE-Org/Resonate/blob/master/ONBOARDING.md)
+[Onboarding Guide](https://github.com/AOSSIE-Org/Resonate/blob/HEAD/ONBOARDING.md)Also applies to: 140-146
🤖 Prompt for AI Agents
In README.md around lines 96 to 105 (and also update the similar occurrence at
140-146), the hardcoded GitHub links reference the `master` branch while
CONTRIBUTING specifies `dev`, causing inconsistency; either (A) change the
displayed branch name and all links to the actual target branch (e.g., `dev`) so
text and links match, or (B) make the links branch-agnostic by replacing
absolute blob URLs with relative repository paths (e.g., link to ONBOARDING.md
using a relative link) or use the `blob/HEAD/...` form so future default-branch
changes won’t break links—apply the same change to the other section at lines
140-146.
| ## 🎬 App Screenshots | ||
|
|
||
| <div align="center"> | ||
|
|
||
| | Login Screen (Forest) | Home Screen (Time) | Create Room Screen (Time) | | ||
| | :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------- | | ||
| | <img src= "https://github.com/user-attachments/assets/e76147b1-0e51-4852-8198-06bbc975b25c" width="260" height="auto" /> | <img src="https://github.com/user-attachments/assets/ad62eecb-b621-4c31-a01c-001ff5462b28" width="250" height="auto" /> | <img src="https://github.com/user-attachments/assets/31ce6e73-8dca-4e2d-8f48-c22480fa1332" width="250" height="auto" /> | | ||
|
|
||
| | Room Screen (Cream) | Profile Screen (Amber) | Explore Story (Forest) | | ||
| | :---------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------- | | ||
| | <img src="https://github.com/user-attachments/assets/f1d6e62f-5f25-47c1-9f59-e165d7018c0c" width="250" height="auto" /> | <img src="https://github.com/user-attachments/assets/b9dfe363-79b1-4eee-8d00-28f5c14f93ee" width="250" height="auto" /> | <img src="https://github.com/user-attachments/assets/c7657be8-bce2-4c3a-aee3-dd3cc33379a2" width="250" height="auto"/> | | ||
| | Login (Forest) | Home (Time) | Create Room (Time) | | ||
| |---------------|------------|-------------------| | ||
| | <img src="https://github.com/user-attachments/assets/e76147b1-0e51-4852-8198-06bbc975b25c" width="260"/> | <img src="https://github.com/user-attachments/assets/ad62eecb-b621-4c31-a01c-001ff5462b28" width="250"/> | <img src="https://github.com/user-attachments/assets/31ce6e73-8dca-4e2d-8f48-c22480fa1332" width="250"/> | | ||
|
|
||
| | Room (Cream) | Profile (Amber) | Explore Story (Forest) | | ||
| |-------------|-----------------|------------------------| | ||
| | <img src="https://github.com/user-attachments/assets/f1d6e62f-5f25-47c1-9f59-e165d7018c0c" width="250"/> | <img src="https://github.com/user-attachments/assets/b9dfe363-79b1-4eee-8d00-28f5c14f93ee" width="250"/> | <img src="https://github.com/user-attachments/assets/c7657be8-bce2-4c3a-aee3-dd3cc33379a2" width="250"/> | | ||
|
|
||
| | Explore Story (Amber) | Theme Screen (Vintage) | Upcoming Room Screen (Cream) | | ||
| | :---------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------- | | ||
| | <img src="https://github.com/user-attachments/assets/ba7da784-48a6-4512-a4c8-9f12b8ad13c1" width="250" height="auto" /> | <img src="https://github.com/user-attachments/assets/ba9273f2-ceef-441d-8f94-4e0bc53b3e99" width="250" height="auto" /> | <img src="https://github.com/user-attachments/assets/a46c7da4-2df4-4c62-9e4c-9c92102339e9" width="250" height="auto"/> | | ||
| | Explore (Amber) | Theme (Vintage) | Upcoming Room (Cream) | | ||
| |----------------|-----------------|-----------------------| | ||
| | <img src="https://github.com/user-attachments/assets/ba7da784-48a6-4512-a4c8-9f12b8ad13c1" width="250"/> | <img src="https://github.com/user-attachments/assets/ba9273f2-ceef-441d-8f94-4e0bc53b3e99" width="250"/> | <img src="https://github.com/user-attachments/assets/a46c7da4-2df4-4c62-9e4c-9c92102339e9" width="250"/> | | ||
|
|
||
| </div> |
There was a problem hiding this comment.
Add alt text to screenshot <img> tags to satisfy MD045 and improve accessibility.
-| <img src="https://github.com/user-attachments/assets/e76147b1-0e51-4852-8198-06bbc975b25c" width="260"/> | <img src="https://github.com/user-attachments/assets/ad62eecb-b621-4c31-a01c-001ff5462b28" width="250"/> | <img src="https://github.com/user-attachments/assets/31ce6e73-8dca-4e2d-8f48-c22480fa1332" width="250"/> |
+| <img src="https://github.com/user-attachments/assets/e76147b1-0e51-4852-8198-06bbc975b25c" width="260" alt="Login (Forest) screen"/> | <img src="https://github.com/user-attachments/assets/ad62eecb-b621-4c31-a01c-001ff5462b28" width="250" alt="Home (Time) screen"/> | <img src="https://github.com/user-attachments/assets/31ce6e73-8dca-4e2d-8f48-c22480fa1332" width="250" alt="Create Room (Time) screen"/> |
...
-| <img src="https://github.com/user-attachments/assets/f1d6e62f-5f25-47c1-9f59-e165d7018c0c" width="250"/> | <img src="https://github.com/user-attachments/assets/b9dfe363-79b7-4eee-8d00-28f5c14f93ee" width="250"/> | <img src="https://github.com/user-attachments/assets/c7657be8-bce2-4c3a-aee3-dd3cc33379a2" width="250"/> |
+| <img src="https://github.com/user-attachments/assets/f1d6e62f-5f25-47c1-9f59-e165d7018c0c" width="250" alt="Room (Cream) screen"/> | <img src="https://github.com/user-attachments/assets/b9dfe363-79b7-4eee-8d00-28f5c14f93ee" width="250" alt="Profile (Amber) screen"/> | <img src="https://github.com/user-attachments/assets/c7657be8-bce2-4c3a-aee3-dd3cc33379a2" width="250" alt="Explore Story (Forest) screen"/> |
...
-| <img src="https://github.com/user-attachments/assets/ba7da784-48a6-4512-a4c8-9f12b8ad13c1" width="250"/> | <img src="https://github.com/user-attachments/assets/ba9273f2-ceef-441d-8f94-4e0bc53b3e99" width="250"/> | <img src="https://github.com/user-attachments/assets/a46c7da4-2df4-4c62-9e4c-9c92102339e9" width="250"/> |
+| <img src="https://github.com/user-attachments/assets/ba7da784-48a6-4512-a4c8-9f12b8ad13c1" width="250" alt="Explore (Amber) screen"/> | <img src="https://github.com/user-attachments/assets/ba9273f2-ceef-441d-8f94-4e0bc53b3e99" width="250" alt="Theme (Vintage) screen"/> | <img src="https://github.com/user-attachments/assets/a46c7da4-2df4-4c62-9e4c-9c92102339e9" width="250" alt="Upcoming Room (Cream) screen"/> |Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
126-126: Images should have alternate text (alt text)
(MD045, no-alt-text)
126-126: Images should have alternate text (alt text)
(MD045, no-alt-text)
126-126: Images should have alternate text (alt text)
(MD045, no-alt-text)
130-130: Images should have alternate text (alt text)
(MD045, no-alt-text)
130-130: Images should have alternate text (alt text)
(MD045, no-alt-text)
130-130: Images should have alternate text (alt text)
(MD045, no-alt-text)
134-134: Images should have alternate text (alt text)
(MD045, no-alt-text)
134-134: Images should have alternate text (alt text)
(MD045, no-alt-text)
134-134: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In README.md around lines 120 to 136, each <img> tag in the App Screenshots
section is missing alt attributes; add meaningful alt text to every <img> tag
(e.g., "Login screen — Forest theme", "Home screen — Time theme", "Create Room —
Time theme", etc.) or use an empty alt="" only for purely decorative images,
ensuring all images include an alt attribute to satisfy MD045 and improve
accessibility.
| ## 📬 Communication Channels | ||
|
|
||
| - **Discord**: https://discord.gg/MMZBadkYFm | ||
| - **Email**: [[email protected]](mailto:[email protected]) | ||
|
|
There was a problem hiding this comment.
Replace bare Discord URL with a proper Markdown link (MD034).
-- **Discord**: https://discord.gg/MMZBadkYFm
+- **Discord**: [discord.gg/MMZBadkYFm](https://discord.gg/MMZBadkYFm)📝 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.
| ## 📬 Communication Channels | |
| - **Discord**: https://discord.gg/MMZBadkYFm | |
| - **Email**: [[email protected]](mailto:[email protected]) | |
| ## 📬 Communication Channels | |
| - **Discord**: [discord.gg/MMZBadkYFm](https://discord.gg/MMZBadkYFm) | |
| - **Email**: [[email protected]](mailto:[email protected]) | |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
158-158: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In README.md around lines 156 to 160 the Discord link is a bare URL which
triggers MD034; replace it with a proper Markdown link by wrapping the URL in
link text (e.g., change the line to use
[Discord](https://discord.gg/MMZBadkYFm)) so the URL is not bare and conforms to
the Markdown rule.
| <p align="left"> | ||
| <a href="https://github.com/AOSSIE-Org" target="_blank"> | ||
| <img src="https://img.shields.io/badge/GitHub-AOSSIE--Org-181717?style=for-the-badge&logo=github"/> | ||
| </a> | ||
| <a href="https://www.linkedin.com/company/aossie" target="_blank"> | ||
| <img src="https://img.shields.io/badge/LinkedIn-AOSSIE-0A66C2?style=for-the-badge&logo=linkedin"/> | ||
| </a> | ||
| <a href="https://twitter.com/aossie_org" target="_blank"> | ||
| <img src="https://img.shields.io/badge/X-@aossie__org-000000?style=for-the-badge&logo=x"/> | ||
| </a> | ||
| <a href="https://www.instagram.com/aossie_org" target="_blank"> | ||
| <img src="https://img.shields.io/badge/Instagram-AOSSIE-E4405F?style=for-the-badge&logo=instagram"/> | ||
| </a> | ||
| </p> |
There was a problem hiding this comment.
Add alt text to badge images and consider dropping target="_blank" here too.
MD045 flags these; add alt attributes for accessibility/tooling compliance.
- <img src="https://img.shields.io/badge/GitHub-AOSSIE--Org-181717?style=for-the-badge&logo=github"/>
+ <img src="https://img.shields.io/badge/GitHub-AOSSIE--Org-181717?style=for-the-badge&logo=github" alt="GitHub: AOSSIE-Org"/>
...
- <img src="https://img.shields.io/badge/LinkedIn-AOSSIE-0A66C2?style=for-the-badge&logo=linkedin"/>
+ <img src="https://img.shields.io/badge/LinkedIn-AOSSIE-0A66C2?style=for-the-badge&logo=linkedin" alt="LinkedIn: AOSSIE"/>
...
- <img src="https://img.shields.io/badge/X-@aossie__org-000000?style=for-the-badge&logo=x"/>
+ <img src="https://img.shields.io/badge/X-@aossie__org-000000?style=for-the-badge&logo=x" alt="X: @aossie__org"/>
...
- <img src="https://img.shields.io/badge/Instagram-AOSSIE-E4405F?style=for-the-badge&logo=instagram"/>
+ <img src="https://img.shields.io/badge/Instagram-AOSSIE-E4405F?style=for-the-badge&logo=instagram" alt="Instagram: aossie_org"/>📝 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.
| <p align="left"> | |
| <a href="https://github.com/AOSSIE-Org" target="_blank"> | |
| <img src="https://img.shields.io/badge/GitHub-AOSSIE--Org-181717?style=for-the-badge&logo=github"/> | |
| </a> | |
| <a href="https://www.linkedin.com/company/aossie" target="_blank"> | |
| <img src="https://img.shields.io/badge/LinkedIn-AOSSIE-0A66C2?style=for-the-badge&logo=linkedin"/> | |
| </a> | |
| <a href="https://twitter.com/aossie_org" target="_blank"> | |
| <img src="https://img.shields.io/badge/X-@aossie__org-000000?style=for-the-badge&logo=x"/> | |
| </a> | |
| <a href="https://www.instagram.com/aossie_org" target="_blank"> | |
| <img src="https://img.shields.io/badge/Instagram-AOSSIE-E4405F?style=for-the-badge&logo=instagram"/> | |
| </a> | |
| </p> | |
| <p align="left"> | |
| <a href="https://github.com/AOSSIE-Org" target="_blank"> | |
| <img src="https://img.shields.io/badge/GitHub-AOSSIE--Org-181717?style=for-the-badge&logo=github" alt="GitHub: AOSSIE-Org"/> | |
| </a> | |
| <a href="https://www.linkedin.com/company/aossie" target="_blank"> | |
| <img src="https://img.shields.io/badge/LinkedIn-AOSSIE-0A66C2?style=for-the-badge&logo=linkedin" alt="LinkedIn: AOSSIE"/> | |
| </a> | |
| <a href="https://twitter.com/aossie_org" target="_blank"> | |
| <img src="https://img.shields.io/badge/X-@aossie__org-000000?style=for-the-badge&logo=x" alt="X: @aossie__org"/> | |
| </a> | |
| <a href="https://www.instagram.com/aossie_org" target="_blank"> | |
| <img src="https://img.shields.io/badge/Instagram-AOSSIE-E4405F?style=for-the-badge&logo=instagram" alt="Instagram: aossie_org"/> | |
| </a> | |
| </p> |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
167-167: Images should have alternate text (alt text)
(MD045, no-alt-text)
170-170: Images should have alternate text (alt text)
(MD045, no-alt-text)
173-173: Images should have alternate text (alt text)
(MD045, no-alt-text)
176-176: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
In README.md around lines 165 to 178, the badge <img> tags are missing alt
attributes and use target="_blank"; add descriptive alt text for each badge
(e.g., "GitHub - AOSSIE-Org", "LinkedIn - AOSSIE", "X - @aossie_org", "Instagram
- AOSSIE") to satisfy MD045 and accessibility requirements, and remove the
target="_blank" attributes from the surrounding <a> tags (or keep them only if
intentionally required and then also add rel="noopener noreferrer") so the
markup is both accessible and lint-compliant.
|
What issue is this related to? |
2 participants
Updated README.md to enhance formatting, improve clarity, and add new logos.
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes # (issue)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Please include screenshots below if applicable.
Checklist:
Maintainer Checklist
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.