-
Notifications
You must be signed in to change notification settings - Fork 2.7k
docs: add beginner explanation for single agent example #4099
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
base: main
Are you sure you want to change the base?
docs: add beginner explanation for single agent example #4099
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello @yukthagangadhari5, 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 enhances the ADK documentation by introducing a concise, beginner-oriented explanation of what an 'agent' represents within the framework. This addition, placed strategically before the initial code example in the README, aims to clarify fundamental concepts for new users, thereby streamlining their learning curve and improving overall readability without impacting any functional aspects of the system. Highlights
🧠 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 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 adds a helpful explanation for beginners about what an 'agent' is in the ADK, right before the first code example. The change is well-intentioned and improves the onboarding experience. I've suggested a small formatting tweak to the new documentation to improve its readability and make the Markdown more robust for future edits.
README.md
Outdated
| **Beginner note:** | ||
| In ADK, an *agent* is a Python object that defines how your AI system behaves — | ||
| including its instructions, the tools it can use, and how it responds to users. | ||
| The example below shows the simplest way to define a single agent. |
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.
This is a great addition for new users! For better readability and more robust Markdown formatting, I suggest separating the note's title from the content with a blank line and combining the explanation into a single paragraph. This avoids using trailing spaces for line breaks, which can be fragile and harder to maintain.
| **Beginner note:** | |
| In ADK, an *agent* is a Python object that defines how your AI system behaves — | |
| including its instructions, the tools it can use, and how it responds to users. | |
| The example below shows the simplest way to define a single agent. | |
| **Beginner note:** | |
| In ADK, an *agent* is a Python object that defines how your AI system behaves — including its instructions, the tools it can use, and how it responds to users. The example below shows the simplest way to define a single agent. |
|
Hi @yukthagangadhari5 , Thank you for your contribution! It appears you haven't yet signed the Contributor License Agreement (CLA). Please visit https://cla.developers.google.com/ to complete the signing process. Once the CLA is signed, we'll be able to proceed with the review of your PR. Thank you! |
|
Hi Rohit, thank you for the message! I’ve already signed the Google Individual Contributor License Agreement earlier today. It may still be syncing with GitHub, but please let me know if there’s anything else needed from my side. |
|
Thank you! I’ve now signed the Google CLA and the check is passing. |
Description of the change
Problem:
New users may find it unclear what an “agent” represents in ADK before encountering the first code example in the README.
Solution:
Added a short beginner-friendly explanation before the single-agent example to clarify what an ADK agent is and what the example demonstrates. This improves readability and onboarding without changing any existing behavior or code.
Testing Plan
This change is documentation-only and does not affect runtime behavior. No tests were required or run.
Checklist
Additional context
This change is intended to improve the onboarding experience for users exploring ADK for the first time.