Skip to content

Fix typos and grammar errors in user guide#19193

Merged
seanbudd merged 2 commits into
nvaccess:masterfrom
EricMaxFelder:fix-userguide-documentation
Nov 12, 2025
Merged

Fix typos and grammar errors in user guide#19193
seanbudd merged 2 commits into
nvaccess:masterfrom
EricMaxFelder:fix-userguide-documentation

Conversation

@EricMaxFelder

Copy link
Copy Markdown
Contributor

Link to issue number:

No existing issue - documentation improvement

Summary of the issue:

The userGuide.md contained multiple typos, grammar errors, and inconsistencies that needed correction to improve documentation quality.

Description of user facing changes:

Improved clarity and correctness of the NVDA User Guide through fixing:

  • 5 spelling errors (itallic→italic, meanning→meaning, bloks→blocks, sortered→sorted, THE→The)
  • 3 grammar errors (by assign→by assigning, wil→will, tree→three)
  • 5 inconsistencies in terminology and capitalization (NvDA→NVDA)
  • 1 duplicate key mapping in Eurobraille keyboard commands

Total: 19 documentation improvements. No functional changes.

Description of developer facing changes:

None - documentation only changes

Description of development approach:

Performed comprehensive review of userGuide.md and corrected errors found. Changes are purely editorial with no impact on functionality.

Testing strategy:

Manual review of all changes to ensure:

  • Spelling corrections are accurate
  • Grammar improvements are correct
  • Terminology is consistent with NVDA conventions
  • No unintended changes to meaning or functionality

Known issues with pull request:

None

Code Review Checklist:

  • Documentation:
    • Change log entry (not required for minor documentation fixes)
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests (not applicable)
    • System (end to end) tests (not applicable)
    • 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.

Corrects spelling mistakes (itallic→italic, meanning→meaning, bloks→blocks, sortered→sorted), grammar issues (by assign→by assigning, wil→will, tree→three), inconsistent capitalization (NvDA→NVDA, THE→The), and fixes duplicate key mapping for control+end in Eurobraille keyboard commands.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@EricMaxFelder EricMaxFelder requested a review from a team as a code owner November 8, 2025 06:43
@seanbudd seanbudd changed the title Fix typos and grmar errors in user guideam Fix typos and grammar errors in user guide Nov 11, 2025
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Nov 11, 2025

@Qchristensen Qchristensen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

All well picked up, thanks!

@seanbudd seanbudd merged commit 4c7832f into nvaccess:master Nov 12, 2025
27 of 29 checks passed
@github-actions github-actions Bot added this to the 2026.1 milestone Nov 12, 2025
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