Skip to content

doc: Update README with new llms.txt approach, coding with AI guide, and other fixes #3840

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
koverholt wants to merge 5 commits into
base: main
Choose a base branch
from
+15 −33,231
Open

doc: Update README with new llms.txt approach, coding with AI guide, and other fixes #3840

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fcb7b25
Update vibe coding in README with updated llms.txt approach
koverholt Dec 5, 2025
3bd6a3c
Formatting
koverholt Dec 5, 2025
daae379
Various fixes to README
koverholt Dec 5, 2025
85b94d1
Update contribution wording
koverholt Dec 5, 2025
8c97527
Tweak description of generated llms.txt
koverholt Dec 5, 2025
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
24 changes: 15 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ deployment-agnostic, and compatible with other frameworks.
- **Agent Config**: Build agents without code. Check out the
[Agent Config](https://google.github.io/adk-docs/agents/config/) feature.

- **Tool Confirmation**: A [tool confirmation flow(HITL)](https://google.github.io/adk-docs/tools/confirmation/) that can guard tool execution with explicit confirmation and custom input.
- **Tool Confirmation**: A [tool confirmation flow (HITL)](https://google.github.io/adk-docs/tools/confirmation/) that can guard tool execution with explicit confirmation and custom input.

- **Modular Multi-Agent Systems**: Design scalable applications by composing
multiple specialized agents into flexible hierarchies.
Expand Down Expand Up @@ -115,7 +115,7 @@ root_agent = Agent(

### Define a multi-agent system:

Define a multi-agent system with coordinator agent, greeter agent, and task execution agent. Then ADK engine and the model will guide the agents works together to accomplish the task.
Define a multi-agent system with a coordinator agent, greeter agent, and task execution agent. Then ADK and model will guide the agents to work together to accomplish the task.

```python
from google.adk.agents import LlmAgent, BaseAgent
Expand Down Expand Up @@ -152,23 +152,29 @@ adk eval \

## 🤝 Contributing

We welcome contributions from the community! Whether it's bug reports, feature requests, documentation improvements, or code contributions, please see our
- [General contribution guideline and flow](https://google.github.io/adk-docs/contributing-guide/).
- Then if you want to contribute code, please read [Code Contributing Guidelines](./CONTRIBUTING.md) to get started.
We welcome contributions from the community! Whether it's bug reports, feature requests, documentation improvements, or code contributions, please see our:

- [General contribution guideline and flow](https://google.github.io/adk-docs/contributing-guide/)
- For code contributions, please read the [Code Contributing Guidelines](./CONTRIBUTING.md) to get started

## Community Repo

We have [adk-python-community repo](https://github.com/google/adk-python-community)that is home to a growing ecosystem of community-contributed tools, third-party
The [adk-python-community repo](https://github.com/google/adk-python-community) is home to a growing ecosystem of community-contributed tools, third-party
service integrations, and deployment scripts that extend the core capabilities
of the ADK.
of ADK.

## Vibe Coding

If you are to develop agent via vibe coding the [llms.txt](./llms.txt) and the [llms-full.txt](./llms-full.txt) can be used as context to LLM. While the former one is a summarized one and the later one has the full information in case your LLM has big enough context window.
Accelerate your ADK agent development workflow with AI-assisted coding. ADK provides optimized documentation context compatible with AI code editors:

- **[llms.txt](https://google.github.io/adk-docs/llms.txt)**: A structured index of ADK documentation, designed to help LLMs navigate and locate specific topics and guides.
- **[llms-full.txt](https://google.github.io/adk-docs/llms-full.txt)**: The comprehensive documentation reference, ideal for complex implementations or models with large context windows.

You can also visit our [Coding with AI](https://google.github.io/adk-docs/tutorials/coding-with-ai/) guide for instructions on using these files with development tools like Gemini CLI and Antigravity.

## Community Events

- [Completed] ADK's 1st community meeting on Wednesday, October 15, 2025. Remember to [join our group](https://groups.google.com/g/adk-community) to get access to the [recording](https://drive.google.com/file/d/1rpXDq5NSH8-MyMeYI6_5pZ3Lhn0X9BQf/view), and [deck](https://docs.google.com/presentation/d/1_b8LG4xaiadbUUDzyNiapSFyxanc9ZgFdw7JQ6zmZ9Q/edit?slide=id.g384e60cdaca_0_658&resourcekey=0-tjFFv0VBQhpXBPCkZr0NOg#slide=id.g384e60cdaca_0_658).
- [Completed] ADK's 1st community meeting on Wednesday, October 15, 2025. Remember to [join our group](https://groups.google.com/g/adk-community) to get access to the [recording](https://drive.google.com/file/d/1rpXDq5NSH8-MyMeYI6_5pZ3Lhn0X9BQf/view) and [deck](https://docs.google.com/presentation/d/1_b8LG4xaiadbUUDzyNiapSFyxanc9ZgFdw7JQ6zmZ9Q/edit?slide=id.g384e60cdaca_0_658&resourcekey=0-tjFFv0VBQhpXBPCkZr0NOg#slide=id.g384e60cdaca_0_658).

## 📄 License

Expand Down
Loading