search

Quansight-Labs / bokeh-a11y-audit

Bokeh accessibility audit findings and env setup for the CZI EOSS grant cycle 6
BSD 3-Clause "New" or "Revised" License
3 stars 0 forks source link

Bokeh dashboard for accessibility audit #2

Closed pavithraes closed 2 months ago

pavithraes commented 2 months ago

Closes https://github.com/Quansight-Labs/czi-bokeh-mgmt/issues/12

Deployed with GitHub pages at https://quansight-labs.github.io/bokeh-a11y-audit/

The dashboard includes:

This PR adds the code to generate the dashboard. The exported index.html file is checked into the pages branch.

pavithraes commented 2 months ago

@trallard @frankelavsky In additional to general thoughts, I'd love specific feedback on:

trallard commented 2 months ago

Thanks, @pavithraes. I think having this dashboard will be a lot more helpful than fishing for examples in the documentation.

If the notes regarding plots & possible interactions in the dashboard are clear or I can fill any gaps there

These make sense to me, but I also know we discussed these plots and interactions. So, I will let @frankelavsky ask questions or notes if needed.

If the way interactions & annotation are included in the plots works. We can alternatively separate out each annotation (i.e., text, arrow, etc.) and/or widget interaction (i.e., dropdown, etc.) into separate plots so that each plot only uses one main component.

These work as they are; there are only a couple of interactions added per plot. I think the annotations are fine (legend, title, labels, and others), and annotations of the type "mathematical notation/text + arrow" since these are some of the most commonly used annotations.

If @frankelavsky is happy with this, we could merge and then move to it for the main audit tasks vs. the Bokeh docs.

frankelavsky commented 2 months ago

I absolutely love this, this is great and easily saves a bazillion hours of scouring around. As of right now (before I've audited), the interactions/examples seem to be good enough to really get a spread of things. But of course, if anything comes up that I'd like to see changed/added - I'll let you know.

frankelavsky commented 2 months ago

Oh and as a note: I am assuming that the notes are for me, the auditor and not written as though they are notes for a hypothetical user.

Cognitive accessibility is important, but I also know we are not intending to structure these demos as "attempting to pass accessibility" but rather setting a baseline for defaults and common uses/designs. Since it is the latter, expect cognitive/understandability-related failures for things that might seem obvious (like "you need to add a description of what this is or does"). But those are also things that we can develop some easy strategies for once we get to the solutioning/synthesizing stage of things.

trallard commented 2 months ago

Correct, those notes are aimed at the auditor (you @frankelavsky).

Seems we're all happy with this dashboard as is for now so I will go ahead and merge this and @frankelavsky can use this for the rest of the audit 🎉

Thanks for working on this so quickly @pavithraes