Review 2024.3 documentation changes #16742

seanbudd · 2024-06-26T03:03:46Z

Must be a squash merge

Changes from this PR to the previous release:

Files to check: user_docs/en/userGuide.md, user_docs/en/changes.md developerGuide.md
Compare this branch to the previous release
Comparison command:
git diff release-2024.2...docsFor2024.3 -- "**/en/*.md" "**/developerGuide.md"

Common mistakes to check for:

Issue/PR reference in changes file is incorrect
Incorrect spelling.
Shortcuts added without code markdown (e.g. NVDA+d)
List items not indented by a multiple of 2 spaces (regex ^ ( )*-)
Double spaces (regex [^ ] )
Inconsistent use of single vs double quote. (regex ' )

Summary by CodeRabbit

New Features
- Added support for Help Tech Activator Pro displays.
- Introduced new key commands and notification for add-on updates on NVDA startup.
Enhancements
- Updated dependencies: LibLouis, fast_diff_match_patch, NSIS, markdown, and nh3.
- Enhanced Unicode normalization and Unicode CLDR.
Bug Fixes
- Various bug fixes improving overall stability.
Documentation
- Updated user guide with new configuration options for NVDA modifier keys.
- Added detailed information about tables in NVDA add-ons to the developer guide.

coderabbitai · 2024-06-26T03:03:54Z

Walkthrough

The updates involve enhancements and new feature additions to NVDA, including detailed documentation on table support in add-ons, configuration updates for the NVDA modifier key, and various functional updates, bug fixes, and dependency upgrades in user documentation.

Changes

File Path	Change Summary
`projectDocs/dev/developerGuide/...`	Added details about tables in NVDA add-ons, including display name, input/output support, and braille type.
`user_docs/en/changes.md`	Documented functionality changes, feature additions, updates, and enhancements, including updates to various dependencies.
`user_docs/en/userGuide.md`	Updated configuration options for NVDA modifier key, specifying key names in backticks and adjusting default keys.

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 4

user_docs/en/changes.md

Qchristensen

All looks good.

CyrilleB79

Here is my review.

In addition to the comments in the code, the following points should be looked at in the change log:

"menuitems": rather use "menu items" with dash
Remove the following sentence which is useless since there are no deprecations:
Please refer to [the developer guide](https://www.nvaccess.org/files/nvda/documentation/developerGuide.html#API) for information on NVDA's API deprecation and removal process.
Note that this has not been removed for 2024.2, but IMO, it was a mistake.

user_docs/en/changes.md

CyrilleB79 · 2024-06-27T12:33:02Z

user_docs/en/changes.md

 * Windows 11 fixes:
  * NVDA will no longer appear to get stuck when closing the clipboard history and emoji panel. (#16346, #16347, @josephsl)
-  * NVDA will announce visible candidates again when opening the Windows 11 IME interface. (#14023, @josephsl)
+  * NVDA will announce visible candidates again when opening the IME interface. (#14023, @josephsl)
  * NVDA will no longer announce "clipboard history" twice when navigating through the emoji panel menu items. (#16532, @josephsl)


@josephsl do you confirm this change log item? Seems strange that NVDA was announcing "clipboard history" in the emoji panel. Or was it a copy/paste issue with the other change?

Seems accurate to the original issue: #16532

The title of the original issue mentions emoji panel, but the STR only mentions Clipboard history panel and its shortcut (windows+V).
That's why I was assuming that there were a cfusion somewhere and that I had tagged @josephsl for checking.

Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>

seanbudd added 2 commits June 26, 2024 12:55

Review 2024.3 documentation changes

a7f20cb

minor fixups

dba8599

seanbudd requested review from a team as code owners June 26, 2024 03:03

seanbudd requested review from Qchristensen and michaelDCurran June 26, 2024 03:03

seanbudd requested review from gerald-hartig and CyrilleB79 June 26, 2024 03:05

coderabbitai bot reviewed Jun 26, 2024

View reviewed changes

user_docs/en/changes.md Outdated Show resolved Hide resolved

user_docs/en/changes.md Outdated Show resolved Hide resolved

user_docs/en/changes.md Outdated Show resolved Hide resolved

user_docs/en/changes.md Outdated Show resolved Hide resolved

seanbudd marked this pull request as draft June 26, 2024 03:30

minor fixes

32479fa

seanbudd marked this pull request as ready for review June 27, 2024 01:53

Qchristensen reviewed Jun 27, 2024

View reviewed changes

Qchristensen approved these changes Jun 27, 2024

View reviewed changes

seanbudd added this to the 2024.3 milestone Jun 27, 2024

seanbudd marked this pull request as draft June 27, 2024 07:21

seanbudd added 2 commits June 27, 2024 17:31

Merge remote-tracking branch 'origin/master' into docsFor2024.3

80ae080

renormalize contents

b32810e

seanbudd marked this pull request as ready for review June 27, 2024 07:33

CyrilleB79 reviewed Jun 27, 2024

View reviewed changes

seanbudd and others added 7 commits June 28, 2024 11:01

Apply suggestions from code review

62319b2

Co-authored-by: Cyrille Bougot <cyrille.bougot2@laposte.net>

code review comments

5a769b2

fix merge conflicts

e6e9b22

use startup consistently

76a103e

Merge remote-tracking branch 'origin/master' into docsFor2024.3

fa762a2

fix changelog

53bf9a7

Merge branch 'master' into docsFor2024.3

0d012d7

seanbudd merged commit ba04b51 into master Jul 1, 2024
3 checks passed

seanbudd deleted the docsFor2024.3 branch July 1, 2024 00:13

coderabbitai bot mentioned this pull request Nov 10, 2024

Fix 2024.4.1 changelog #17381

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Review 2024.3 documentation changes #16742

Review 2024.3 documentation changes #16742

seanbudd commented Jun 26, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 26, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

Qchristensen left a comment

CyrilleB79 left a comment

CyrilleB79 Jun 27, 2024

seanbudd Jun 28, 2024

CyrilleB79 Jun 28, 2024

Review 2024.3 documentation changes #16742

Review 2024.3 documentation changes #16742

Conversation

seanbudd commented Jun 26, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Jun 26, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

Qchristensen left a comment

Choose a reason for hiding this comment

CyrilleB79 left a comment

Choose a reason for hiding this comment

CyrilleB79 Jun 27, 2024

Choose a reason for hiding this comment

seanbudd Jun 28, 2024

Choose a reason for hiding this comment

CyrilleB79 Jun 28, 2024

Choose a reason for hiding this comment

seanbudd commented Jun 26, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 26, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)