feat(docs): Update README Documentation with ADK#686
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #686 +/- ##
==========================================
+ Coverage 81.51% 81.59% +0.08%
==========================================
Files 125 125
Lines 12101 12101
==========================================
+ Hits 9864 9874 +10
+ Misses 1505 1497 -8
+ Partials 732 730 -2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
fb900e4 to
b5aa0e1
Compare
- 在概述中新增 ADK 一行介绍 - 重构 ReAct 部分,将编排能力说明前移,使用 ADK ChatModelAgent 示例替换旧实现 - 新增 ADK 详细功能展示:多智能体上下文管理、中断/恢复机制、预置模式、中间件系统 - 在关键特性中新增智能体开发套件(ADK)章节 - 将切面(Callbacks)合并到强大的编排章节 - 更新框架结构图链接 - 同步更新中英文 README Change-Id: I0ae5a325f390d781dbae01f852aaeb8c1dc412e7
b5aa0e1 to
1b07b4c
Compare
N3kox
approved these changes
Jan 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update README Documentation with ADK (Agent Development Kit) Introduction
Summary
This PR updates both English and Chinese README files to reflect the current state of the Eino framework, with a particular focus on introducing the Agent Development Kit (ADK) package—a significant addition that was previously undocumented.
Motivation
The existing README focused primarily on the
composepackage (Chain, Graph, Workflow) for orchestration but omitted theadkpackage entirely. This created a gap between the documentation and the actual capabilities of the framework. The ADK represents a higher-level abstraction layer built on top of compose, optimized for building AI agents with less boilerplate—a distinction that needed to be clearly communicated to users.Key Decisions
1. Organic Integration over Separate Documentation
Rather than creating a separate ADK documentation section, we integrated ADK naturally into the existing document flow. The ReAct agent example—which was previously implemented using raw graph orchestration—now uses
ChatModelAgent, demonstrating how ADK simplifies common patterns while the underlying orchestration benefits remain available.2. Restructured "Quick Walkthrough" Section
3. Emphasized ADK's Core Strengths
Added concrete examples for:
SetSubAgentsandNewAgentToolwith automatic conversation history rewriting4. Consolidated Aspects into Powerful Orchestration
The separate "Highly Extensible Aspects (Callbacks)" section was merged into "Powerful Orchestration" as a bullet point. This reflects that aspects are a feature of the orchestration system rather than a standalone capability.
5. Updated Framework Imagery
Replaced outdated framework structure diagrams with current versions that better represent the project architecture.
Changes
ChatModelAgentexample