AccessKit / accesskit

Accessibility infrastructure for UI toolkits
https://accesskit.dev
BSD 3-Clause "New" or "Revised" License
1.05k stars 53 forks source link

Explain naming scheme for NodeBuilder, Action, DefaultActionVerb, etc, in documentation #402

Open PoignardAzur opened 5 months ago

PoignardAzur commented 5 months ago

AccessKit includes a few types with undocumented methods, variants, etc:

It's clear enough that these method/variant names come from somewhere, but it's not clear what. My understanding from what you said is that the names come from the Chromium accessibility API? But I'm not sure what that API even is.

While in the long term it would be better to document every property, in the short term it would be nice if the four types listed above could include a link to respective page for the Chromium spec they draw from. This way people trying to understand AccessKit's semantics could at least use the Chromium spec as a starting point.