Various rewordings, punctuation additions, and light fixes to the Developer Guide.

[XLTechie]

Summary of the issue:

While reading the dev guide, I noticed several things that could be improved.
Mainly these are punctuation changes (missing commas, backticks, etc.), or wording changes to improve the English.
I believe I also added a couple internal links.

Description of user facing changes

None.

Description of development approach

See description of issue.

Testing strategy:

Known issues with pull request:

Code Review Checklist:

• Documentation:
  • Change log entry
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• Testing: N/A
• UX of all users considered:N/A
• API is compatible with existing add-ons.N/A
• Security precautions taken. N/A

Summary by CodeRabbit

• Documentation
  • Enhanced clarity and precision in the NVDA developer guide.
  • Improved readability through sentence restructuring and grammatical corrections.
  • Clarified explanations of the NVDA Add-on API’s evolution, including new features and deprecated libraries.
  • Standardized terminology and formatting for technical terms.
  • Updated guidance on gesture definitions for better adaptability to keyboard layouts.
  • Refined examples for gesture remapping for improved accessibility.

[coderabbitai]

Walkthrough

The recent modifications to the NVDA developer guide primarily focus on improving clarity and precision. Enhancements include restructuring sentences for better readability, updating terminology for consistency, and refining technical examples. These changes aim to assist developers in understanding the NVDA Add-on API, new features, and gesture remapping, ultimately making the document more user-friendly and accessible.

Changes

File Path	Change Summary
projectDocs/dev/developerGuide/developerGuide.md	Restructured sentences for clarity, expanded explanations of API changes, updated terminology consistency, clarified gesture definitions, refined examples, and corrected punctuation.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant NVDA_Documentation
    participant NVDA_Addon_API
    participant Translator

    Developer->>NVDA_Documentation: Review guide
    NVDA_Documentation->>Developer: Provide updated info
    Developer->>NVDA_Addon_API: Implement new features
    NVDA_Addon_API-->>Developer: Return feedback
    Developer->>Translator: Share guidelines for translations
    Translator-->>Developer: Provide translated content

Loading

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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 Configuration 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.

[AppVeyorBot]

See test results for failed build of commit de8d9ec846

[Qchristensen]

Reads well, good work going through all of that!

[SaschaCowley]

Thanks for going through and making these changes, @XLTechie .