docs(overlay): a11y docs update

[TarunAdobe]

Description

Improving the accessibility documentation of components.

Related issue(s)

• SWC-390

Motivation and context

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

How has this been tested?

Review overlay 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? You can use the WAVE browser extension's Structure tab to review heading structure.

• Did it pass in Desktop?

• Did it pass in Mobile?

• Did it pass in iPad?

Screenshots (if appropriate)

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.

[changeset-bot]

⚠️ No Changeset found

Latest commit: e3e76b2

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

[github-actions]

Branch preview

• Documentation Site
• Storybook

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:

• Spectrum | Light | Medium | LTR
• Spectrum | Dark | Large | RTL
• Express | Light | Medium | LTR
• Express | Dark | Large | RTL
• Spectrum-two | Light | Medium | LTR
• Spectrum-two | Dark | Large | RTL
• High Contrast Mode | Medium | LTR

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.

[github-actions]

Tachometer results

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

[nikkimk]

Do we want sp-tabs with examples of some of these placement options?

[nikkimk]

I don't see these yet.

[TarunAdobe]

We have examples of how to use the placement attribute in the docs so I wonder if we need to show all examples of all possible values for that attributes in this case. Thought it might be too redundant. But I am open to have my thoughts changed here

[castastrophe]

A few suggestions for heading cases and wording but otherwise this is a great update with lots of improvements in it.

[nikkimk]

I wonder if we should use the alert-banner for our notices.

[nikkimk]

I wonder if we should use the alert-banner for our notices.

[nikkimk]

Just a bit more feedback. Overall this is very impressive work and I appreciate the time you spent making this more understandable to both the consumers and the contributors.