Fixes in User Guide for beta #16822
Fixes in User Guide for beta #16822
Conversation
| @@ -1916,7 +1917,7 @@ For example, the latin letter "h" can also be presented as "𝐡" (bold), "ℎ" | |||
| This aspect of normalization also aids in reading equations in the Microsoft Word equation editor. | |||
|
|
|||
| 1. Normalization to composed characters. | |||
| For example, the character "ü" (u with umlaut/diaeresis), a common character in languages like German and Turkish can be represented in two forms. | |||
| For example, the character "ü" (u with umlaut/diaeresis), a common character in languages like German and Turkish can be represented in two forms: | |||
There was a problem hiding this comment.
colon to announce the following 2-item list.
| This will open a dialog which allows you to create a portable copy of NVDA out of the installed version. | ||
|
|
||
| The dialog to create a portable copy of NVDA or to install NVDA on this PC will prompt you to choose a folder path in which NVDA should create the portable copy or in which NVDA should be installed. | ||
| This will open a dialog which allows you to create a portable copy of NVDA out of the currently running version. |
There was a problem hiding this comment.
If I am not mistaken, creating a portable copy from another portable one or from the temporary copy of the installer use the currently running copy as source, not the installed copy (which may not exist by the way).
| @@ -3656,9 +3657,7 @@ For more information, read the in-depth section: [Add-ons and the Add-on Store]( | |||
|
|
|||
| ### Create portable copy {#CreatePortableCopy} | |||
|
|
|||
| This will open a dialog which allows you to create a portable copy of NVDA out of the installed version. | |||
|
|
|||
| The dialog to create a portable copy of NVDA or to install NVDA on this PC will prompt you to choose a folder path in which NVDA should create the portable copy or in which NVDA should be installed. | |||
There was a problem hiding this comment.
I have removed this line because:
- Now that we have linked below a detailed paragraph about portable copy creation including the description of the dialog, describing the dialog here is not needed anymore.
- this line also mentions NVDA's installation whereas the current paragraph is about portable copy creation.
| @@ -3656,9 +3657,7 @@ For more information, read the in-depth section: [Add-ons and the Add-on Store]( | |||
|
|
|||
| ### Create portable copy {#CreatePortableCopy} | |||
There was a problem hiding this comment.
Before 2024.3beta1, this paragraph was mentioning more or less the case where NVDA can be installed from the tools menu of a portable (or temporary) copy.
This is now less the case, and actually all the references to NVDA's installation are being removed from this paragraph in this PR.
To make things clear, we should create a dedicated paragraph "Install NVDA".to describe this item from the Tools submenu, with a link to the detailed paragraph about installation. Can it be accepted here or should I do it in another PR against master (i.e. for 2024.4)?
WalkthroughThe recent updates to the Changes
Sequence Diagram(s)No sequence diagrams required for these documentation 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 CodeRabbit Configration File (
|
![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 and nitpick comments (2)
user_docs/en/userGuide.md (2)
54-54: Ensure Consistency in System Requirements PresentationThe addition of the RAM requirement is clear. However, ensure that both the recommended and minimum system requirements sections consistently mention RAM.
2948-2948: Ensure Consistency in TerminologyThe label change from "Enabled" to "Notify" is clear. Ensure this change is consistently applied throughout the document wherever this option is referenced.
Link to issue number:
None
Summary of the issue:
Some fixes seen in NVDA's user guide during translation.
Description of user facing changes
See User Guide
Description of development approach
N/A
Testing strategy:
Check generated user guide
Known issues with pull request:
None
Code Review Checklist:
Summary by CodeRabbit