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
docs: support diagramming without image files #2559
Comments
If it makes creating and maintaining diagrams easier then it could definitely be worth adding yeah. I just want to do a bit of investigating on how it is for accessibility, but I'll report back here with my findings next week. |
So, after doing some digging, it looks like they've already been working hard on the accessibility problem. Accessibility is always going to be tricky with content of this type, because it's hard to write good alt text or captions that really describes what the content is conveying (in a brief way). However, that problem exists for any diagram/flow chart. Although they're not fully there yet, the fact that they are aware of the issues and are actively working on various ways of improving their accessibility means that this is automatically better than the standard ways of creating these images. This proposal gets a thumbs up from me - thanks for bringing it to my attention! |
It occurs to me that this needs an action - over the next cycle I'll add some documentation around this to our devdocs and link the PR here when it's up |
We could use https://github.com/mgaitan/sphinxcontrib-mermaid or something similar to more easily add and edit diagrams in our documentation.
Not urgent but WDYT @s-makin?
The text was updated successfully, but these errors were encountered: