Review 2024.4 changelog and documentation changes #17030
Conversation
WalkthroughThe recent updates focus on enhancing documentation clarity and improving NVDA's functionality, particularly for braille support and user experience. Key changes include refined system requirements, improved braille cursor routing, and streamlined user instructions. These modifications ensure users receive precise information, facilitating better accessibility and usability, especially for those relying on braille and speech feedback. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (4)
user_docs/en/userGuide.md (4)
43-46: Clarify support for 32-bit operating systems.The note "32-bit operating systems are no longer under active support" is potentially confusing. It's unclear if this refers to NVDA's support or Microsoft's support for these systems. Consider rephrasing for clarity.
* Note: NVDA no longer actively supports 32-bit operating systems.
46-46: Clarify support status for older Windows Server versions.The note "Windows Server versions older than 2022 are no longer under active support" could be more explicit about whether this is NVDA's support or Microsoft's. Consider rephrasing for clarity.
* Note: NVDA no longer actively supports Windows Server versions older than 2022.
51-54: Ensure consistent punctuation in list items.The list items in the "Recommended System Requirements" section should end with a period for consistency.
* Operating Systems: 64-bit editions of Windows 10, Windows 11, and Windows Server 2022. * Both AMD64 and ARM64 variants of Windows are supported. * At least 150 MB of storage space. * At least 4 GB of RAM.
Line range hint
66-73: Clarify braille display detection feature.The sentence "NVDA will detect many braille displays automatically by default" could be more precise. Specify whether this refers to USB, Bluetooth, or both types of connections.
Furthermore, NVDA will automatically detect many braille displays via USB and Bluetooth by default.
There was a problem hiding this comment.
Looks good to me generally, nice work! Can you message @Qchristensen for a review?
Co-authored-by: Sean Budd <[email protected]>
user_docs/en/changes.md
Outdated
| @@ -2,21 +2,41 @@ | |||
|
|
|||
| ## 2024.4 | |||
|
|
|||
| ### Important notes | |||
| This release includes a number of improvements to braille. | |||
There was a problem hiding this comment.
To me, putting this first, and listing off all of the braille changes, makes it seem like that was the focus of this release, and was all that changed.
Since there are so many braille changes, and miscellaneous other changes, I would suggest putting the list of braille stuff last.
There was a problem hiding this comment.
Done, let me know what you think.
There was a problem hiding this comment.
- NVDA once again relies on events for caret movement in several cases, rather than only on manual querying of the caret position.
This item and the 3 sub-items are in the bug fix section. But this does not describe at all a visible bug fix.
Either we put all these items in the developer changes paragraph, if it is worth it. Or we replace with the visible consequence of these changes.
According to the PRs, the visible consequences are:
- None, though caret movement would possibly be detected a little bit faster in XAML and WPF controls. (#16817)
- Possibly slightly faster caret navigation in Firefox and Chrome. ()(#16817)
And even there, what is the visible impact for the user? Does it mean that the speech/braille feedback would be slightly faster when navigating in these applications?
Or if the visible change is not obvious, just remove these changes items.
Regarding the PR for the terminal (#16873), is there a visible change at all?
- The
boolconfiguration key[documentFormatting][reportFontAttributes]is deprecated for removal in 2025.1, instead use[fontAttributeReporting]. (#16748)
I'd use simple sentences rather thant sub-items here (i.e. remove bullets of sub-items). I thought that I had already done this remark in the past but cannot find it. So feel free to ignore if I had done it and it had been declined.
…d paragraph marker options explanation.
… have user-facing significance
|
@CyrilleB79 I've removed the mentions of the caret reporting fixes as I agree they made little to know difference to end-users. |
Co-authored-by: Luke Davis <[email protected]>
|
The initial blurb seems longer than for previous releases. Should we add so much details. It seem to me that we could gather improvements and change according to themes in one sentence per topic with less details. E.g. one sentence for braille improvements, one for Office improvements, etc. and the last one for "misc improvements / changes" or "... and many other new features and changes". Just my two cents thought. |
seanbudd
added
the
conceptApproved
Co-authored-by: Sean Budd <[email protected]>
Must be a squash merge
Changes from this PR to the previous release:
user_docs/en/userGuide.md,user_docs/en/changes.mddeveloperGuide.mdgit diff release-2023.3...documentationFor2024 -- "**/en/*.md" "**/developerGuide.md"Common mistakes to check for:
NVDA+d)^ ( )*-)[^ ])')Summary by CodeRabbit
New Features
Bug Fixes
Documentation