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

Per-component accessibility doc updates #1388

Merged
merged 11 commits into from
Jul 27, 2023
Merged

Conversation

msmithNI
Copy link
Contributor

@msmithNI msmithNI commented Jul 25, 2023

Pull Request

🤨 Rationale

Resolves #1090

In PR discussion on #1272, we decided that the per-component accessibility notes would be better documented in Storybook (by the other component docs), instead of in accessibility.md.

Resolves #1393

👩‍💻 Implementation

For components with accessibility notes not already documented in Storybook:

  • Create an mdx docs page for them, if it wasn't already present. Based on PR comments on the recent PR by Jesse, I think this is the general direction we're going for component docs.
  • Add a Usage Docs / Accessibility section at the bottom, and add the notes from accessibility.md. The button/spinner mdx have these sections, so again following the existing patterns.

🧪 Testing

Manual verification in Storybook.

✅ Checklist

  • I have updated the project documentation to reflect my changes or determined no changes are needed.

@msmithNI msmithNI linked an issue Jul 25, 2023 that may be closed by this pull request
5 tasks
@msmithNI msmithNI marked this pull request as ready for review July 25, 2023 21:31
@rajsite
Copy link
Member

rajsite commented Jul 26, 2023

The wafer map changes are straightforward doc formatting changes so I don't think we need to block on reviews from @DStavilaNI @zszilagy (but y'all feel free to pipe in if we need to address something in a follow-up)

@msmithNI msmithNI enabled auto-merge (squash) July 26, 2023 23:32
@msmithNI msmithNI disabled auto-merge July 26, 2023 23:39
@msmithNI msmithNI enabled auto-merge (squash) July 26, 2023 23:58
@msmithNI msmithNI merged commit 0eaa7f3 into main Jul 27, 2023
4 checks passed
@msmithNI msmithNI deleted the accessibility-doc-cleanup branch July 27, 2023 00:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants