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: Make "Edit in Stackblitz" links explicit #40766

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

hannahiss
Copy link
Contributor

@hannahiss hannahiss commented Aug 23, 2024

Description

At the beginning of page "Examples", add an aria-labelledby to the 10 links "Edit in Stackblitz" to make them discriminating and explicit

Motivation & Context

Accessibility issue: the different links must have different accessible names

Type of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (non-breaking change)
  • Breaking change (fix or feature that would change existing functionality)

Checklist

  • I have read the contributing guidelines
  • My code follows the code style of the project (using npm run lint)
  • My change introduces changes to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

Live previews

Related issues

@hannahiss hannahiss marked this pull request as ready for review September 4, 2024 06:29
@patrickhlauke
Copy link
Member

this approach seems a bit overengineered to me, but I can see why (since WCAG flip-flopped on whether or not preceding headings are or aren't programmatically determined context - see for instance w3c/wcag#3361).

so, while a bit excessive, I don't mind this approach, but wondering: is this really the only place where this change would be needed? are there other stackblitz links anywhere else in the docs that would need this?

Copy link
Member

@patrickhlauke patrickhlauke left a comment

Choose a reason for hiding this comment

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

happy with this in principle, but see my comment about whether or not there are other places where this change should also be implemented

@hannahiss
Copy link
Contributor Author

happy with this in principle, but see my comment about whether or not there are other places where this change should also be implemented

Thanks Patrick for your feedback. I updated the description of the PR which was outdated.
About whether or not there are other places with these kind of links, this PR is just about the 10 links at the beginning of the "examples" page, not about the "Edit in Stackblitz" buttons which would be more difficult to fix...

Copy link
Member

@julien-deramond julien-deramond left a comment

Choose a reason for hiding this comment

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

Patrick: [...]so, while a bit excessive, I don't mind this approach, but wondering: is this really the only place where this change would be needed? are there other stackblitz links anywhere else in the docs that would need this?

Hannah: About whether or not there are other places with these kind of links, this PR is just about the 10 links at the beginning of the "examples" page, not about the "Edit in Stackblitz" buttons which would be more difficult to fix...

I agree with Patrick; I'm fine with this approach, and I believe this PR can be merged as is. However, @hannahiss, for consistency, could you check if it's possible to apply the same changes to the 'Edit in Stackblitz' buttons elsewhere in a follow-up PR? I'm not entirely sure if it's feasible, but it's worth exploring.

site/layouts/partials/examples/main.html Outdated Show resolved Hide resolved
Copy link
Member

@julien-deramond julien-deramond left a comment

Choose a reason for hiding this comment

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

Thanks for the modifications @hannahiss and the PR, LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Ready to merge
Development

Successfully merging this pull request may close these issues.

4 participants