Skip to content

Update Quick Start Guide#19174

Merged
SaschaCowley merged 3 commits into
nvaccess:masterfrom
CyrilleB79:qsGuide
Nov 11, 2025
Merged

Update Quick Start Guide#19174
SaschaCowley merged 3 commits into
nvaccess:masterfrom
CyrilleB79:qsGuide

Conversation

@CyrilleB79

Copy link
Copy Markdown
Contributor

This PR fixes issues seen in the Quick Start Guide while writing another PR.

Link to issue number:

None

Summary of the issue:

The Quick Start Guide (QSG) contains the following issues:

  • It mentions unassigned commands; unassigned commands should not be mentioned in the Quick Start Guide since:
    • if they are unassigned, they are probably not so common to deserve to be in the QSG
    • the QSG does not indicate how to assign a gesture to a command, which makes mentioning unassigned commands useless in this guide.
  • There is a paragraph on the synth settings ring commands in the QSG, but the user would not even know what it is.
  • Other unassigned commands are mentioned in the synth settings ring paragraph of the QSG.

Description of user facing changes:

  • Removed unassigned "Report language" from the QSG.
  • Added an initial description of the synth setting ring at the top of its dedicated paragraph in the QSG.
  • Removed the mention of unassigned commands to jumpt to the first/last value in the synth ring commands since they are not assigned, for same reason as above.

Description of developer facing changes:

N/A

Description of development approach:

N/A

Testing strategy:

Check the generated User Guide.

Known issues with pull request:

None

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

@CyrilleB79 CyrilleB79 marked this pull request as ready for review November 5, 2025 22:16
@CyrilleB79 CyrilleB79 requested a review from a team as a code owner November 5, 2025 22:16
@CyrilleB79

Copy link
Copy Markdown
Contributor Author

Cc @nvdaes FYI since I guess you were the one to add the report language command.

@seanbudd

seanbudd commented Nov 6, 2025

Copy link
Copy Markdown
Member

the QSG does not indicate how to assign a gesture to a command, which makes mentioning unassigned commands useless in this guide.

I think we should solve this, rather than taking out useful information on potential commands. NVDA gestures are already fairly crowded.

if they are unassigned, they are probably not so common to deserve to be in the QSG

I think this might not always be true. As the keyboard gets crowded, there will be more and more useful gestures without a default

@Qchristensen

Copy link
Copy Markdown
Member

I agree with the intent here. Some points on the specifics (slightly out of order from the original):

  1. Unassigned "Report Language": I agree this doesn't need to be in the QSG, but should it be covered elsewhere, perhaps somewhere near "12.1.2.13 Report language changes while reading"?

  2. Adding info about what the synth settings ring is - good pickup, and the proposed change reads well.

  3. The paragraph proposed for removal around the unassigned synth settings ring gestures - while this probably doesn't need to be in the QSG for the reasons given, the information is arguably useful and should perhaps be moved to basically exactly the same place, under the table of commands, in section "12.1.4 Synth Settings Ring" in the User Guide.

  4. I agree that assigning a custom gesture probably doesn't need to be in the QSG - if there is a gesture we feel is important enough that a user should know it quite early in the use of NVDA, then it probably should have a gesture assigned to begin with. The exception to this would be for a user coming from another screen reader which had a command assigned which the user likes, which NVDA doesn't assign by default. In that case, however, having that command documented in places such as the Switching from Jaws to NVDA guide - I've linked there specifically to the quick navigation section, which mentions jumping between articles which is assigned in Jaws, and notes using the input gestures dialog to assign them if needed.

@CyrilleB79

Copy link
Copy Markdown
Contributor Author

@Qchristensen thanks for the review.

  1. Unassigned "Report Language": I agree this doesn't need to be in the QSG, but should it be covered elsewhere, perhaps somewhere near "12.1.2.13 Report language changes while reading"?

Sorry, my intent was to move it.
Since @nvdaes had put it next to report formatting and report link destination, I have sticked to this choice, which seems relevant. But put the command in the general guide rather than in the QSG.

  1. The paragraph proposed for removal around the unassigned synth settings ring gestures - while this probably doesn't need to be in the QSG for the reasons given, the information is arguably useful and should perhaps be moved to basically exactly the same place, under the table of commands, in section "12.1.4 Synth Settings Ring" in the User Guide.

Sorry, I thought that it was covered in the general guide. I have added them with other synth settings ring commands, mentioning "none" to denote it's unassigned. That's what we tend to do recently, rather than writing text. This way, it also appears in the Commands Quick Reference.

  1. I agree that assigning a custom gesture probably doesn't need to be in the QSG - if there is a gesture we feel is important enough that a user should know it quite early in the use of NVDA, then it probably should have a gesture assigned to begin with. The exception to this would be for a user coming from another screen reader which had a command assigned which the user likes, which NVDA doesn't assign by default. In that case, however, having that command documented in places such as the Switching from Jaws to NVDA guide - I've linked there specifically to the quick navigation section, which mentions jumping between articles which is assigned in Jaws, and notes using the input gestures dialog to assign them if needed.

OK. This should be studied case by case and should be documented in the "Moving from Jaws to NVDA" Guide rather than in the QSG.

@CyrilleB79

Copy link
Copy Markdown
Contributor Author

@seanbudd wrote:

the QSG does not indicate how to assign a gesture to a command, which makes mentioning unassigned commands useless in this guide.

I think we should solve this, rather than taking out useful information on potential commands. NVDA gestures are already fairly crowded.

if they are unassigned, they are probably not so common to deserve to be in the QSG

I think this might not always be true. As the keyboard gets crowded, there will be more and more useful gestures without a default

@seanbudd did you realize that I am talking about the QSG (Quick Start Guide)? I am nnot talking about the User Guide in general. Just to be sure...

And re unassigned gestures, I agree that we should continue to cover them in the general User Guide, but not in the Quick Start Guide section.

Re assigning gestures, it's covered in paragraph "12.2.3. Input Gestures". IMO it does not need to be covered in the Quick Start Guide section too.

@seanbudd

seanbudd commented Nov 7, 2025

Copy link
Copy Markdown
Member

@CyrilleB79 - I did mean QSG, but Quentin disagrees - I will defer to him on this 😄

@CyrilleB79

Copy link
Copy Markdown
Contributor Author

This PR is ready again.

There seems to be flaky Chrome tests. I have had to push an empty commit to re-run them and make them pass.

@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Nov 11, 2025

@Qchristensen Qchristensen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks Cyrille!

@Qchristensen Qchristensen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks Cyrille

@SaschaCowley SaschaCowley merged commit 27993de into nvaccess:master Nov 11, 2025
29 checks passed
@github-actions github-actions Bot added this to the 2026.1 milestone Nov 11, 2025
@CyrilleB79 CyrilleB79 deleted the qsGuide branch November 13, 2025 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants