Skip to content

Conversation

@yukthagangadhari5
Copy link

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

  • I have read the CONTRIBUTING.md document.
  • I have performed a self-review of my own change.
  • I have commented my code, particularly in hard-to-understand areas. (Not applicable – documentation only)
  • I have added tests that prove my fix is effective or that my feature works. (Not applicable – documentation only)
  • New and existing unit tests pass locally with my changes. (Not applicable – documentation only)
  • I have manually tested my changes end-to-end. (Not applicable – documentation only)
  • Any dependent changes have been merged and published in downstream modules. (Not applicable)

Additional context

This change is intended to improve the onboarding experience for users exploring ADK for the first time.

@google-cla
Copy link

google-cla bot commented Jan 8, 2026

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.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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

  • Documentation Enhancement: Added a beginner-friendly explanation to the README.md file, clarifying the concept of an 'agent' in ADK before the first code example.
  • Improved Onboarding: The new explanation aims to improve the onboarding experience for new users by making the purpose and definition of an ADK agent more explicit.
  • No Code Changes: This pull request is documentation-only and does not alter any existing code or runtime behavior of the application.

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

@adk-bot adk-bot added the documentation [Component] This issue is related to documentation, it will be transferred to adk-docs label Jan 8, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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
Comment on lines 101 to 104
**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.
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

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.

Suggested change
**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.

@ryanaiagent ryanaiagent self-assigned this Jan 9, 2026
@ryanaiagent
Copy link
Collaborator

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!

@ryanaiagent ryanaiagent added the request clarification [Status] The maintainer need clarification or more information from the author label Jan 9, 2026
@yukthagangadhari5
Copy link
Author

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.

@yukthagangadhari5
Copy link
Author

Thank you! I’ve now signed the Google CLA and the check is passing.
Please let me know if any further changes are needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation [Component] This issue is related to documentation, it will be transferred to adk-docs request clarification [Status] The maintainer need clarification or more information from the author

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants