-
Notifications
You must be signed in to change notification settings - Fork 342
Phase 1: ADK Onboarding journey revision #739
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?
Conversation
joefernandez
commented
Oct 6, 2025
- Quickstart: split by language and reduce time
- Build your agent: new section for agent building
- Home page: Simplify onboarding choices
- Surface "About ADK" in navigation
- Quickstart: split by language and reduce time - Build your agent: new section for agent building - Home page: Simplify onboarding choices - Surface "About ADK" in navigation
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.
Thanks for the revisions! I listed a few optimizations for the Python page, and the Java quickstart page needs some additional reworking. Overall I love the more streamlined getting started pages and the reorganization of the "Build your agent" tutorials!
- completely revised Java quickstart
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.
Thanks for the updates, the updated Java quickstart page is looking great! The main blocking issue that I ran into is on the Java quickstart page when running with the web UI, and I left a few other minor comments.
|
||
```shell | ||
```bash title="Update: my_agent/.env" | ||
echo 'export GOOGLE_API_KEY="YOUR_API_KEY"' > .env |
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.
echo 'export GOOGLE_API_KEY="YOUR_API_KEY"' > .env | |
echo 'GOOGLE_API_KEY="YOUR_API_KEY"' > .env |
These are read in as key-value pairs, so no need to export to the current environment.
=== "MacOS / Linux" | ||
|
||
```bash title="Update: my_agent/.env" | ||
echo 'export GOOGLE_API_KEY="YOUR_API_KEY"' > .env |
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.
echo 'export GOOGLE_API_KEY="YOUR_API_KEY"' > .env | |
echo 'GOOGLE_API_KEY="YOUR_API_KEY"' > .env |
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 image matches the output of the Java-based agent and tool, but the Python-based agent will return:
I am sorry, I cannot provide the time for London.
Should we use different images to match the output of each agent? Or refactor so the agent's tool implementation is the same and thus the output is the same?
|
||
 | ||
This command starts a web server with a chat interface for your agent. You can | ||
access the web interface at (http://localhost:8080). Select the agent at the |
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.
access the web interface at (http://localhost:8080). Select the agent at the | |
access the web interface at (http://localhost:8000). Select the agent at the |
The default port in Python for adk web
is 8000.
This project uses the Gemini API, which requires an API key. If you | ||
don't already have Gemini API key, create a key in Google AI Studio on the | ||
[API Keys](https://aistudio.google.com/app/apikey) page. |
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 project uses the Gemini API, which requires an API key. If you | |
don't already have Gemini API key, create a key in Google AI Studio on the | |
[API Keys](https://aistudio.google.com/app/apikey) page. | |
This quickstart uses the Gemini API in Google AI Studio, which requires an API | |
key. If you don't already have a Gemini API key, create a key in Google AI | |
Studio on the [API Keys](https://aistudio.google.com/app/apikey) page. |
src/main/java/com/example/agent/ | ||
HelloTimeAgent.java # main agent code |
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.
src/main/java/com/example/agent/ | |
HelloTimeAgent.java # main agent code | |
src/main/java/com/example/agent/HelloTimeAgent.java # main agent code |
Suggest unwrapping this line to remove ambiguity.
Create an agent project with the following files and directory structure: | ||
|
||
```console | ||
my_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.
Assuming that the my_agent/src/main/java/com/example/agent/AgentCliRunner.java
file is a required / core part of the Java quickstart, should we add this file here as well to ensure its creation for later?
```console | ||
mvn compile exec:java -Dexec.mainClass="com.example.agent.AgentCliRunner" | ||
``` |
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.
I tested this with ADK Java, and it's working as expected. Thanks!
```console | ||
mvn compile exec:java -Dexec.mainClass="com.google.adk.web.AdkWebServer" \ | ||
-Dexec.args="--adk.agents.source-dir=src/main/java/com/example/agent --server.port=8080" |
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.
- Java: get-started/streaming/quickstart-streaming-java.md | ||
- Testing: get-started/testing.md | ||
- Code samples: https://github.com/google/adk-samples | ||
- Advanced setup: get-started/installation.md |
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.
In the contents of this page, do we want to update the pom.xml
to match the latest versions shown on the Java quickstart page? Or should we go ahead and remove this page in this PR for now?