Skip to content
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

docs: Change "here" link to more descriptive text #7058

Merged
merged 1 commit into from
Jan 16, 2025

Conversation

6TELOIV
Copy link
Contributor

@6TELOIV 6TELOIV commented Jan 16, 2025

Description

docs change

Describe the changes in this pull request

Links with text like "here" or "click here" are not as easily interpretable to screen reader users as links which describe the destination in the link text rather than before/after the link.

The existing text was not a failure of SC 2.4.4 but this change should improve its accessibility.

Many other options of phrasing are possible (the beauty of communication and language!) to please modify if you have a phrase that better conveys the original's author intent.

Test plan

n/a

Before

You can see how it's used in the playground here

After

You can see how TwitterPlugin is used in the playground.

Links with text like "here" or "click here" are not as easily interpretable to screen reader users as links which describe the destination in the link text rather than before/after the link.

The existing text was not a failure of [SC 2.4.4](https://www.w3.org/WAI/WCAG21/Understanding/link-purpose-in-context.html) but this change should improve its accessibility.
Copy link

vercel bot commented Jan 16, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
lexical ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 16, 2025 9:37pm
lexical-playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 16, 2025 9:37pm

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jan 16, 2025
Copy link

size-limit report 📦

Path Size
lexical - cjs 29.03 KB (0%)
lexical - esm 28.87 KB (0%)
@lexical/rich-text - cjs 37.97 KB (0%)
@lexical/rich-text - esm 30.92 KB (0%)
@lexical/plain-text - cjs 36.52 KB (0%)
@lexical/plain-text - esm 28.13 KB (0%)
@lexical/react - cjs 39.79 KB (0%)
@lexical/react - esm 32.28 KB (0%)

Copy link
Collaborator

@etrepum etrepum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change looks good and it's more clear written this way by any measure. Thank you!

@etrepum etrepum added this pull request to the merge queue Jan 16, 2025
Merged via the queue into facebook:main with commit 92a1cd7 Jan 16, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants