Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Add section on add-on store to the Quick Start Guide in the User Guide #16486
Add section on add-on store to the Quick Start Guide in the User Guide #16486
Changes from 11 commits
b9b3dce
08b46f9
40c359a
ee4a5f0
6187db4
80ec23f
343f613
954c03d
301761c
ad683a2
b72f7a1
c3d69fd
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should probably mention the "Community reviews" here?
I'm also not sure we should add too much more here when we don't actually mention this in 13.2 - perhaps we should expand on this in 13.2 and add a brief mention here that "As with any software, it is important to be confident in the developer of an add-on before using it. Section 13.2.1 contains tips on researching add-ons and authors, such as community reviews"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That sounds like a better solution.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have created PR #16510 to add @gerald-hartig's suggestions to the main add-on section. I'd like to propose that PR be accepted at the same time or before this one, so the following makes sense:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not familiar with the term reading here, is it something we use in the rest of the docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't give instructions like this through most of the user guide (that's more a training module area). I feel saying something like this is needed here until #16485 is implemented (if that were implemented, I think we could drop this line). In the meantime, I've suggested"reading text" which links to the quick start guide topic of that name - https://www.nvaccess.org/files/nvda/documentation/userGuide.html#ReadingText Otherwise we could say "Use the Say all, or navigation keys"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Qchristensen I'm not sure "use the reading text" makes sense. It's like "Use the force", without there being a force. :-)
I get that you mean it to be read "Use the reading text keys, or the arrow keys", but even that sounds awkward since "reading text keys" aren't a thing.
"reading keys", okay, as a general shorthand for "review or object nav keys", but "reading text keys"? Hmmm.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like an excuse to write "Use the force" in the user guide somewhere! Happy to accept a change here - I was originally thinking of saying use "Say all", but that is just one of any number of keys you COULD use to read text with. I don't think there are (many, or any?) other examples of this kind of instruction in the User Guide, as it's not how it is written. If we could have NVDA read that whole text field on focus it would negate the need to give any specific instruction here :) I wasn't keen to leave it unsaid though as it is easy to get to that description field, have it read one line and not know whether there is more or that you need to specifically read it if there is.
I just had a look in Basic Training and I mention "Reading keys" or "Reading and navigation keys" in a couple of places.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps this is more of a discussion for #16485 but for me NVDA reports that this field is multiline, which pretty clearly indicates there may be more than one line there. Why it is a problem in the add-on store specifically and not in many other places - when tabbing into an multiline edit field on web pages for example?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section seems more or less identical to
AddonStoreFilterSearch
, perhaps it's just worth moving that section here?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar, but I think worth mentioning in both places - in fact, there shouldn't be much in the quick start guide which ISN'T replicated elsewhere, albeit reworded.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be worth mentioning what fields you can search by (add-on ID, display name, publisher, author or description)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.