Skip to content

Commit 225fafc

Browse files
yukthagangadhari5DeanChensj
authored andcommitted
docs: add beginner explanation for single agent example
Merge google#4099 ### 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 - [x] I have read the CONTRIBUTING.md document. - [x] 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. Co-authored-by: Shangjie Chen <deanchen@google.com> COPYBARA_INTEGRATE_REVIEW=google#4099 from yukthagangadhari5:docs-beginner-note ec2e677 PiperOrigin-RevId: 932731929
1 parent 883ff98 commit 225fafc

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ The release cadence is roughly bi-weekly.
5959

6060
## Quick Start
6161

62+
> **Beginner Note:** ADK applications are built using two main classes:
63+
> **`Agent`** (defines an AI's instructions, tools, and behavior) and
64+
> **`Workflow`** (orchestrates agents and tasks in a graph-based flow).
65+
6266
### Agent
6367

6468
```python

0 commit comments

Comments
 (0)