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

Add accessibility docs for title and description elements #2905

Closed
lindseywild opened this issue Apr 6, 2022 · 2 comments
Closed

Add accessibility docs for title and description elements #2905

lindseywild opened this issue Apr 6, 2022 · 2 comments
Labels
Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request

Comments

@lindseywild
Copy link
Contributor

Is your feature request related to a problem? Please describe.
The work that is being done in #2732 would be great to add to the docs about how to use the title and description elements to create more accessible charts.

Describe the solution you'd like
Documentation explaining the updates, why they're important, and how to use them.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
This is dependent on #2732 and which chart types have implemented the new fields. I think it should wait until that issue is complete before doing this.

@lindseywild lindseywild added Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request labels Apr 6, 2022
@knsv
Copy link
Collaborator

knsv commented Aug 21, 2022

There are some info about this in the docs:
https://mermaid-js.github.io/mermaid/#/accessibility?id=defining-accessibility-options

Can we close this issue?

@lindseywild
Copy link
Contributor Author

@knsv Yep - thank you! If there are follow up suggestions I can open a new story 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants