Skip to content

🎨 Palette: Improve accessibility of "Learn more" links #40

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.

Sign up for GitHub

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

Merged
kastnerp merged 1 commit into from
Mar 29, 2026
Merged

🎨 Palette: Improve accessibility of "Learn more" links #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .Jules/palette.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,6 @@
## 2026-03-25 - Avoid Aria-label Mismatch for Inline Links
**Learning:** Found a pattern where `aria-label`s were used on inline links to provide completely different, more descriptive text than what was visible (e.g., `[Download](url){ aria-label="Download Windows Installer" }`). This is a severe violation of WCAG 2.5.3 (Label in Name) because screen reader users searching for "Download" may not find it, and speech-recognition users saying "Click Download" might fail.
**Action:** Never use `aria-label` to replace poor link text. Instead, always update the visible text to be descriptive and self-sufficient (e.g., `[Download Windows Installer](url)`).
## 2025-03-29 - [Descriptive Link Text]
**Learning:** Using `aria-label` to fix generic link text (like "Learn more") is an anti-pattern when we can just make the visible text itself descriptive. Descriptive visible text helps all users, not just screen reader users, and avoids WCAG 2.5.3 (Label in Name) violations where the label might not contain the visible text perfectly.
**Action:** Always prefer updating the visible text of a link to be descriptive rather than adding an `aria-label` to generic text.
6 changes: 3 additions & 3 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The Grasshopper plugin currently contains three modules, please see below.

---

[:octicons-arrow-right-24: Learn more](https://docs.eddy3d.com/outdoor/){ aria-label="Learn more about Eddy3D Outdoor module" }
[:octicons-arrow-right-24: Learn more about Eddy3D Outdoor](https://docs.eddy3d.com/outdoor/)

- __Eddy3D Outdoor+__

Expand All @@ -22,7 +22,7 @@ The Grasshopper plugin currently contains three modules, please see below.

---

[:octicons-arrow-right-24: Learn more](https://docs.eddy3d.com/outdoorplus/){ aria-label="Learn more about Eddy3D Outdoor+ module" }
[:octicons-arrow-right-24: Learn more about Eddy3D Outdoor+](https://docs.eddy3d.com/outdoorplus/)

- __Eddy3D Indoor__

Expand All @@ -32,7 +32,7 @@ The Grasshopper plugin currently contains three modules, please see below.

---

[:octicons-arrow-right-24: Learn more](https://docs.eddy3d.com/indoor/){ aria-label="Learn more about Eddy3D Indoor module" }
[:octicons-arrow-right-24: Learn more about Eddy3D Indoor](https://docs.eddy3d.com/indoor/)

</div>

Expand Down
Loading