Skip to content

Update ADK doc according to issue #1521 - 24 #1532

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.

Sign up for GitHub

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

Open
adk-bot wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −2
Open

Update ADK doc according to issue #1521 - 24 #1532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/agents/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,12 @@ To create an ADK project for use with Agent Config:

adk create --type=config my_agent

!!! note "Agent naming constraints"
The agent name must be a valid Python identifier. It can only contain
letters, numbers, and underscores (e.g., `my_agent_1`). Names that
contain dashes or other special characters (like `my-agent`) will
result in a loading error.

This command generates a `my_agent/` folder, containing a
`root_agent.yaml` file and an `.env` file.

Expand Down Expand Up @@ -307,4 +313,4 @@ agent definitions in the ADK
[adk-samples](https://github.com/search?q=repo:google/adk-python+path:/%5Econtributing%5C/samples%5C//+root_agent.yaml&type=code)
repository. For detailed information on the syntax and settings supported by
the Agent Config format, see the
[Agent Config syntax reference](/adk-docs/api-reference/agentconfig/).
[Agent Config syntax reference](/adk-docs/api-reference/agentconfig/).
8 changes: 7 additions & 1 deletion docs/get-started/python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ Run the `adk create` command to start a new agent project.
adk create my_agent
```

!!! note "Agent naming constraints"
The agent name must be a valid Python identifier. It can only contain
letters, numbers, and underscores (e.g., `my_agent_1`). Names that
contain dashes or other special characters (like `my-agent`) will
result in a loading error.

### Explore the agent project

The created agent project has the following structure, with the `agent.py`
Expand Down Expand Up @@ -151,4 +157,4 @@ upper left corner and type a request.
Now that you have ADK installed and your first agent running, try building
your own agent with our build guides:

* [Build your agent](/adk-docs/tutorials/)
* [Build your agent](/adk-docs/tutorials/)
Loading