Skip to content

feat(docs): Update README Documentation with ADK#686

Merged
N3kox merged 1 commit intomainfrom
feat/update_readme
Jan 27, 2026
Merged

feat(docs): Update README Documentation with ADK#686
N3kox merged 1 commit intomainfrom
feat/update_readme

Conversation

@shentongmartin
Copy link
Contributor

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 compose package (Chain, Graph, Workflow) for orchestration but omitted the adk package 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

  • Moved the graph orchestration benefits (type checking, stream processing, etc.) to appear immediately after the Workflow example, keeping orchestration concepts together
  • Placed the ReAct/ADK section after orchestration fundamentals, establishing a natural progression from low-level to high-level abstractions

3. Emphasized ADK's Core Strengths

Added concrete examples for:

  • Multi-Agent with Context Management: Demonstrating SetSubAgents and NewAgentTool with automatic conversation history rewriting
  • Interrupt/Resume: Showing the human-in-the-loop capability with checkpoint persistence
  • Prebuilt Patterns: Highlighting Deep Agent (battle-tested), Supervisor, and Sequential patterns
  • Middleware System: Illustrating extensibility without core logic modification

4. 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

  • Added one-line ADK introduction in the overview bullet list
  • Restructured ReAct section with ADK ChatModelAgent example
  • Added comprehensive ADK capability demonstrations
  • Added "Agent Development Kit (ADK)" section under Key Features
  • Merged Aspects content into Powerful Orchestration
  • Updated framework structure images
  • Synchronized all changes between EN and CN READMEs
  • Fixed minor inconsistencies (LlamaIndex → Google ADK, variable naming)

@codecov
Copy link

codecov bot commented Jan 14, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.59%. Comparing base (520e4d8) to head (1b07b4c).
⚠️ Report is 5 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

- 在概述中新增 ADK 一行介绍
- 重构 ReAct 部分,将编排能力说明前移,使用 ADK ChatModelAgent 示例替换旧实现
- 新增 ADK 详细功能展示:多智能体上下文管理、中断/恢复机制、预置模式、中间件系统
- 在关键特性中新增智能体开发套件(ADK)章节
- 将切面(Callbacks)合并到强大的编排章节
- 更新框架结构图链接
- 同步更新中英文 README

Change-Id: I0ae5a325f390d781dbae01f852aaeb8c1dc412e7
@N3kox N3kox merged commit 5f01875 into main Jan 27, 2026
19 checks passed
@N3kox N3kox deleted the feat/update_readme branch January 27, 2026 02:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants