AccessKit / AccessKit/accesskit
Explain naming scheme for Node, Action, etc, in documentation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.5k
- Forks
- 114
- Avg merge
- 8h 25m
- Merged PRs (30d)
- 28
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the docs.rs pages for Action, DefaultActionVerb, NodeBuilder, and Node, then identify the corresponding Chromium accessibility API specifications that define their names and semantics. Done means each of the four types links to its relevant Chromium specification so readers can use it as a reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- accessibility, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100