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

Docs: Accessibility: Document how to use the app with a screen reader #11897

Draft
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

personalizedrefrigerator
Copy link
Collaborator

@personalizedrefrigerator personalizedrefrigerator commented Feb 27, 2025

Summary

This work-in-progress pull request adds basic documentation for using the application with a screen reader (or with only a keyboard).

Feedback on what to include would be welcome!

3. **Editable**: A note editor.
4. **Frame**: A note viewer.

Many screen readers include shortcuts for jumping to the next/previous of each of these roles.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may make sense to link to documentation for some of the popular screen readers. For example, Orca's structural navigation and NVDA's single-letter navigation (Thanks @cary-rowen for the link!).


By default, pressing <kbd>tab</kbd> indents, rather than moves focus. This can be changed by toggling "Tab moves focus" from the "View" menu. By default, this can also be toggled by pressing <kbd>ctrl</kbd>-<kbd>m</kbd>.

## Navigating the mobile app
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section needs more information. Here are a few things it could include:

  • How to select notes (then duplicate/move/delete them) using a screen reader.
  • How to edit a notebook's title/location using a screen reader.
  • How to toggle to-dos.
  • Links to documentation for customizing the toolbar.
  • Links to voice typing documentation (Android).
  • Link to audio recording documentation (this may need to be created).
  • Perhaps also discuss known accessibility issues (though better would be to fix these :) ).

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think giving an overview for now may be good enough? Then the document can be completed over time based on user feedback. The drawback of having a lot of information is that it may become stale and would have to be updated.

@@ -0,0 +1,48 @@
# Keyboard interface
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps instead, this should be:

Suggested change
# Keyboard interface
# Screen reader accessibility

or

Suggested change
# Keyboard interface
# Screen reader support

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I guess we could focus the document on accessibility, so your second title would make sense. In that case the file should be renamed too

@personalizedrefrigerator personalizedrefrigerator added documentation Documentation, web site, README accessibility Related to accessibility labels Feb 27, 2025
@cary-rowen
Copy link

Hi,

It is always useful to write a document for screen reader users.
I will provide a link to "Single-letter Navigation" in the NVDA User Guide.
https://download.nvaccess.org/documentation/en/userGuide.html#SingleLetterNavigation

Thanks,
Cary

@laurent22 laurent22 changed the title Docs: Accessibility: Docuement how to use the app with a screen reader Docs: Accessibility: Document how to use the app with a screen reader Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility Related to accessibility documentation Documentation, web site, README
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants