-
Notifications
You must be signed in to change notification settings - Fork 2.1k
docs: Readme files accuracy fix #1186
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary of ChangesHello @yzhao244, I'm Gemini Code Assist1! 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 enhancing the accuracy and consistency of the project's documentation by addressing minor spelling and capitalization errors. The changes ensure that key terms are presented uniformly, improving the overall quality and professional appearance of the user-facing guides and specifications. Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request aims to correct spelling and capitalization in several documentation files. The changes to 'Helloworld' and 'a2a specification' are correct and improve consistency. However, I've identified a grammatical error introduced in docs/topics/a2a-and-mcp.md, where a verb was incorrectly changed to its singular form for a plural subject. I've provided a suggestion to revert this specific change. The rest of the changes look good.
revert back from AI comments.
The subject of this sentence ("The Agent2Agent (A2A) Protocol and the [Model Context Protocol]...") is plural. The verb should be the plural form "address", not the singular "addresses". The original version was grammatically correct.
## Problem There are a couple of readme file with spelling, capitalization fixes to align with rest of documents. ## Solution “a2a specification” -> “A2A specification”. “Helloworld” -> “Hello World”. ## Changes docs/topics/a2a-and-mcp.md docs/tutorials/python/4-agent-executor.md docs/tutorials/python/7-streaming-and-multiturn.md specification/grpc/README.md ## Testing ✅ Documentation builds successfully with mkdocs ✅ Markdown linting passes ✅ All internal anchor links verified ✅ No broken cross-references ## Issue Fixes a2aproject#1185 --------- Signed-off-by: Yuri Zhao <[email protected]>
Problem
There are a couple of readme file with spelling, capitalization fixes to align with rest of documents.
Solution
“a2a specification” -> “A2A specification”.
“Helloworld” -> “Hello World”.
Changes
docs/topics/a2a-and-mcp.md
docs/tutorials/python/4-agent-executor.md
docs/tutorials/python/7-streaming-and-multiturn.md
specification/grpc/README.md
Testing
✅ Documentation builds successfully with mkdocs
✅ Markdown linting passes
✅ All internal anchor links verified
✅ No broken cross-references
Issue
Fixes #1185