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

Updates to Add-ons section of Quick start guide #16618

Merged
merged 3 commits into from
May 28, 2024

Conversation

CyrilleB79
Copy link
Collaborator

Various rewording found while translating.

Link to issue number:

None

Summary of the issue:

Various re-wordings
needed in the Add-on Store section of the Quick start Guide in the User Guide. Some of them less important than others.

Description of user facing changes

User Guide modified.

Description of development approach

N/A

Testing strategy:

Check the generated file.

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.

Note

NVDA 2024.2 translation freeze has just begun. I have opened this PR against beta branch, but feel free to decline and I will rebase to master; I may also push only some of the change in beta if you wish.
The idea by targeting beta was to update the text before some translators translate it.

@CyrilleB79
Copy link
Collaborator Author

CyrilleB79 commented May 27, 2024

@seanbudd or @gerald-hartig, please note that in the future, it would be nice to avoid merging an important part of the User Guide just before the translation freeze as done with #16553.
Indeed, early translation of important parts of the documentation is an opportunity for translators to re-read the new content and provide early feedback that can be integrated later in the same beta phase. Thanks.

Copy link
Collaborator Author

@CyrilleB79 CyrilleB79 left a comment

Choose a reason for hiding this comment

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

Some specific comments below:

user_docs/en/userGuide.md Show resolved Hide resolved
user_docs/en/userGuide.md Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Show resolved Hide resolved
user_docs/en/userGuide.md Show resolved Hide resolved
user_docs/en/userGuide.md Show resolved Hide resolved
user_docs/en/userGuide.md Show resolved Hide resolved
user_docs/en/userGuide.md Show resolved Hide resolved
user_docs/en/userGuide.md Show resolved Hide resolved
@CyrilleB79 CyrilleB79 marked this pull request as ready for review May 27, 2024 22:20
@CyrilleB79 CyrilleB79 requested a review from a team as a code owner May 27, 2024 22:20
@CyrilleB79 CyrilleB79 requested review from Qchristensen and removed request for a team May 27, 2024 22:20
@CyrilleB79
Copy link
Collaborator Author

@Qchristensen, sorry, I have not been able to take the time to review in detail #16553 before it was merged. Here ar my suggestion.

user_docs/en/userGuide.md Outdated Show resolved Hide resolved
user_docs/en/userGuide.md Outdated Show resolved Hide resolved
@seanbudd seanbudd added this to the 2024.2 milestone May 27, 2024
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label May 28, 2024
@Qchristensen
Copy link
Member

Thanks @CyrilleB79 - all good pickups, and yes, apologies for merging #16553 so late - the idea was something encouraged by feedback given, so we wanted to try to include it for 2024.2, but yes, it was a later inclusion than would have been desirable. Thanks for your understanding!

Co-authored-by: Quentin Christensen <[email protected]>
@seanbudd seanbudd merged commit db6f69f into nvaccess:beta May 28, 2024
1 check was pending
@CyrilleB79 CyrilleB79 deleted the addonStore branch May 28, 2024 16:49
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.

3 participants