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

[DO NOT MERGE]: accessibility docs for SWC07 #4838

Draft
wants to merge 50 commits into
base: main
Choose a base branch
from

Conversation

nikkimk
Copy link
Contributor

@nikkimk nikkimk commented Oct 18, 2024


!!! NOTE TO REVIEWERS !!!

Please only review the docs listed in How has this been tested? section.

When this PR is reviewed, it will be merged into #4756, where all of the changes will be reviewed before merging into main.

Please place any other feedback in #4756


Description

Improving the accessibility documentation of components.

Related issue(s)

Motivation and context

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

How has this been tested?

<sp-asset>

Review asset docs

  • Are the examples accessible?
  • 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?

<sp-combobox>

Review combobox docs

  • Are the examples accessible?
  • 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?

<sp-popover>

Review popover docs

  • Are the examples accessible?
  • 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?

<sp-picker-button>

Review picker button docs

  • Are the examples accessible?
  • 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?

<sp-tray>

Review tray docs

  • Are the examples accessible?
  • 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?

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. N/A
  • 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.

Copy link

Branch preview

Visual regression test results

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

Copy link

github-actions bot commented Oct 18, 2024

Lighthouse scores

Category Latest (report) Main (report) Branch (report)
Performance 0.99 0.99 0.99
Accessibility 1 1 1
Best Practices 1 1 1
SEO 1 0.92 0.92
PWA 1 1 1
What is this?

Lighthouse scores comparing the documentation site built from the PR ("Branch") to that of the production documentation site ("Latest") and the build currently on main ("Main"). Higher scores are better, but note that the SEO scores on Netlify URLs are artifically constrained to 0.92.

Transfer Size

Category Latest Main Branch
Total 229.494 kB 217.18 kB 🏆 217.213 kB
Scripts 58.52 kB 52.445 kB 52.438 kB 🏆
Stylesheet 34.907 kB 30.18 kB 🏆 30.298 kB
Document 6.236 kB 5.462 kB 🏆 5.505 kB
Font 127.009 kB 126.657 kB 126.624 kB 🏆

Request Count

Category Latest Main Branch
Total 52 52 52
Scripts 41 41 41
Stylesheet 5 5 5
Document 1 1 1
Font 2 2 2

@coveralls
Copy link
Collaborator

coveralls commented Oct 18, 2024

Pull Request Test Coverage Report for Build 11411890111

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.229%

Totals Coverage Status
Change from base Build 11386937763: 0.0%
Covered Lines: 32983
Relevant Lines: 33395

💛 - Coveralls

nikkimk and others added 16 commits October 18, 2024 11:29
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
nikkimk and others added 23 commits October 18, 2024 15:53
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
Co-authored-by: Najika Halsema Yoo <44980010+najikahalsema@users.noreply.github.com>
…rum-web-components into nikkimk/a11y-docs-swc07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants