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.

Sign up for GitHub

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

Jump to bottom

docs: 📚 add accessibility notes #1699

Open
44 of 68 tasks
coraliefeil opened this issue Dec 3, 2024 · 1 comment
Open
44 of 68 tasks

docs: 📚 add accessibility notes #1699

coraliefeil opened this issue Dec 3, 2024 · 1 comment
Assignees
@miguelxnxn
Labels
A11y Audit Identifies tasks related to accessibility improvements identified in the A11y audit of the DS documentation We're enhancing SDS doc for improved accessibility, user experience, and workflow efficiency. 🎨 figma needs changes in Figma

Comments

@coraliefeil
Copy link
Contributor

coraliefeil commented Dec 3, 2024 •
edited by miguelxnxn
Loading

Description

We would like to enhance our docs by adding accessibility notes from the a11y audit to each component.

Components:

  • sd-accordion-group
  • sd-accordion
  • sd-audio
  • sd-badge
  • sd-brandshape
  • sd-button
  • sd-carousel-item
  • sd-carousel
  • sd-checkbox-group
  • sd-checkbox
  • sd-combobox
  • sd-dialog
  • sd-divider
  • sd-drawer
  • sd-dropdown
  • sd-expandable
  • sd-flipcard
  • sd-header
  • sd-icon
  • sd-input
  • sd-link
  • sd-map-marker
  • sd-navigation-item
  • sd-notification
  • sd-optgroup
  • sd-option
  • sd-quickfact
  • sd-radio-button
  • sd-radio-group
  • sd-radio
  • sd-scrollable
  • sd-select
  • sd-spinner
  • sd-step-group
  • sd-step
  • sd-switch
  • sd-tab-group
  • sd-tab-pabel
  • sd-tab
  • sd-tag
  • sd-teaser-media
  • sd-teaser
  • sd-textarea
  • sd-tooltip
  • sd-video

Styles:

  • sd-chip
  • sd-container
  • sd-copyright
  • sd-display
  • sd-flag
  • sd-footnotes
  • sd-headline
  • sd-hidden-links
  • sd-interactive
  • sd-leadtext
  • sd-list
  • sd-mark
  • sd-media
  • sd-meta
  • sd-paragraph
  • sd-prose
  • sd-table-cell
  • sd-table

Where to put the documentation

DoR

  • Item has business value
  • Item has been estimated by the team
  • Item is clear and well-defined
  • Item dependencies have been identified

DoD

  • All components display accessibility notes
@coraliefeil coraliefeil added A11y Audit Identifies tasks related to accessibility improvements identified in the A11y audit of the DS documentation We're enhancing SDS doc for improved accessibility, user experience, and workflow efficiency. labels Dec 3, 2024
@coraliefeil coraliefeil moved this to 🏗 In progress in Solid Design System Project Board Dec 3, 2024
@coraliefeil coraliefeil added the 🎨 figma needs changes in Figma label Dec 6, 2024
@auroraVasconcelos auroraVasconcelos mentioned this issue Jan 29, 2025
Open
7 tasks
@yoezlem yoezlem mentioned this issue Jan 29, 2025
Open
5 tasks
@yoezlem
Copy link
Contributor

yoezlem commented Jan 29, 2025

FYI @coraliefeil
@miguelxnxn Can you check all the already completed components?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@miguelxnxn miguelxnxn

Labels
A11y Audit Identifies tasks related to accessibility improvements identified in the A11y audit of the DS documentation We're enhancing SDS doc for improved accessibility, user experience, and workflow efficiency. 🎨 figma needs changes in Figma
Projects
Solid Design System Project Board
Status: 🏗 In progress
Milestone
No milestone
Development

No branches or pull requests
3 participants
@coraliefeil @yoezlem @miguelxnxn