Skip to content

docs: field-label accessibility docs #5364

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

Merged
merged 4 commits into from
Apr 13, 2025

Conversation

caseyisonit
Copy link
Contributor

@caseyisonit caseyisonit commented Apr 10, 2025

Description

Improving the accessibility documentation of components.

Related issue(s)

  • SWC-380

Motivation and context

Documentation should provide more information and examples that demonstrate how to use the components accessibly.

How has this been tested?

<sp-field-label>

Review field label docs

  • Do the docs examples give enough context to test for accessibility?
  • Do the docs examples and text provide information on how to use the component accessibly?
  • If the component is to be used in the context of another component, do the examples include how that component is used accessibly in that context?
  • Are the docs headings logical and consistent across these components? (1)

1. You can use the WAVE browser extension's Structure tab to review heading structure.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (minor updates related to the tooling or maintenance of the repository, does not impact compiled assets)

Checklist

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • If my change required a change to the documentation, I have updated the documentation in this pull request.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices

Best practices

This repository uses conventional commit syntax for each commit message; note that the GitHub UI does not use this by default so be cautious when accepting suggested changes. Avoid the "Update branch" button on the pull request and opt instead for rebasing your branch against main.

@caseyisonit caseyisonit requested a review from a team as a code owner April 10, 2025 20:00
Copy link

Branch preview

Review the following VRT differences

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

Copy link

Tachometer results

Currently, no packages are changed by this PR...

@caseyisonit caseyisonit added a11y Issues related to accessibility ready-for-review labels Apr 10, 2025
Copy link
Contributor

@nikkimk nikkimk left a comment

Choose a reason for hiding this comment

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

Just a few changes, but looks good. I'll defnitely be doing my docs updates this way!

Copy link

changeset-bot bot commented Apr 11, 2025

⚠️ No Changeset found

Latest commit: b97e92f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

@nikkimk nikkimk left a comment

Choose a reason for hiding this comment

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

lgtm

@blunteshwar blunteshwar merged commit db9f8b6 into main Apr 13, 2025
24 checks passed
@blunteshwar blunteshwar deleted the caseyisonit/SWC-380-field-label-docs branch April 13, 2025 00:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y Issues related to accessibility ready-for-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants