-
-
Notifications
You must be signed in to change notification settings - Fork 0
🎨 Palette: Improve accessibility and UX of README badges and links #43
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
Co-authored-by: Moohan <5982260+Moohan@users.noreply.github.com>
|
👋 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 New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdjusts README badges and links to improve accessibility by moving tooltip titles from images to links, updating link destinations for GitHub stats cards, clarifying social/profile tooltip text, and explicitly marking a deprecated package link in text. Flow diagram for README badge and tooltip behaviorflowchart TD
A_User_views_README --> B_Sees_visual_badges
B_Sees_visual_badges --> C_Hover_or_focus_badge
C_Hover_or_focus_badge --> D_Tooltip_from_link_title
D_Tooltip_from_link_title --> E_Action_oriented_description
subgraph GitHub_stats_cards
F_Image_card[Stats_card_image]
G_Link_profile[Link_to_GitHub_profile]
F_Image_card --> G_Link_profile
G_Link_profile --> H_Tooltip_View_profile[Link_title_View_James_Hayes_GitHub_profile]
end
subgraph Social_and_ID_badges
I_ORCID_badge[ORCID_badge_image]
J_Mastodon_badge[Mastodon_badge_image]
K_Bluesky_badge[Bluesky_badge_image]
I_ORCID_badge --> L_ORCID_link[Link_to_ORCID_profile]
J_Mastodon_badge --> M_Mastodon_link[Link_to_Mastodon_profile]
K_Bluesky_badge --> N_Bluesky_link[Link_to_Bluesky_profile]
L_ORCID_link --> L1_ORCID_title[Link_title_View_ORCID_profile]
M_Mastodon_link --> M1_Mastodon_title[Link_title_View_Mastodon_profile]
N_Bluesky_link --> N1_Bluesky_title[Link_title_View_Bluesky_profile]
end
subgraph Deprecated_package_text
O_phstemplates_item[phstemplates_description_text]
P_phssensitivitylabels_link[Link_to_phssensitivitylabels]
Q_deprecated_label[Text_deprecated]
O_phstemplates_item --> P_phssensitivitylabels_link
P_phssensitivitylabels_link --> Q_deprecated_label
end
E_Action_oriented_description --> O1_Improved_accessibility[Improved_screen_reader_context]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
WalkthroughREADME.md badges updated to restructure link and title semantics across technical skills, GitHub statistics, and social profiles. Outer anchors now carry profile-oriented titles while inner images are adjusted accordingly. Added deprecation note for phssensitivitylabels in phstemplates entry. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey - I've left some high level feedback:
- For the two GitHub stats links, consider differentiating the
titletext so that each tooltip reflects the specific card (e.g. one for overall stats, one for top languages) rather than using the same generic profile description for both. - You might want to include the "(deprecated)" marker inside the linked
phssensitivitylabelstext (or in its tooltip) as well, so that the deprecation status is clearly conveyed to assistive technologies that focus on link text alone.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- For the two GitHub stats links, consider differentiating the `title` text so that each tooltip reflects the specific card (e.g. one for overall stats, one for top languages) rather than using the same generic profile description for both.
- You might want to include the "(deprecated)" marker inside the linked `phssensitivitylabels` text (or in its tooltip) as well, so that the deprecation status is clearly conveyed to assistive technologies that focus on link text alone.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
💡 What:
titleattributes for stats cards, social badges, and skills banner to be on the link instead of the image.phssensitivitylabelslink.🎯 Why:
♿ Accessibility:
PR created automatically by Jules for task 7560349995311447420 started by @Moohan
Summary by Sourcery
Improve accessibility and usability of README badges and project links.
Enhancements:
Summary by CodeRabbit