Documentation polish

[jadamcrain]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @jadamcrain, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on a comprehensive polish of the project's documentation. The primary goal is to enhance the clarity, conciseness, and overall readability of the guides and API references. This involves streamlining sentences, correcting grammatical inconsistencies, and ensuring that technical explanations are as straightforward as possible, making it easier for users to quickly grasp key concepts and utilize the library effectively.

Highlights

• Documentation Conciseness: Numerous sections across the documentation have been rephrased to be more concise and direct, improving readability and information density.
• Clarity Improvements: Grammatical corrections and clearer phrasing have been applied to enhance the overall understanding of complex topics such as dependency management, Modbus concepts, API usage, and runtime behavior.
• Language-Specific Bindings: Documentation for C, C++, C#, and Java bindings has been refined to better explain mapping, error handling, iterators, and other language-specific considerations.
• Technical Accuracy: Minor adjustments were made to ensure technical descriptions, such as those for Modbus function codes or TLS certificate validation, are precise and unambiguous.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request provides a great deal of polish to the documentation, making many sentences more concise and direct. The changes improve the overall readability of the guide. I found one minor grammatical error that should be corrected.

[gemini-code-assist]

There appears to be a small grammatical error in this sentence. The word "add" should likely be "a".

* Check every dependency against the whitelist. Our CI packaging will fail if a dependency is added with a license that has not been pre-approved.