Skip to content

docs: prioritize ADK in README feature highlights#719

Merged
shentongmartin merged 1 commit intomainfrom
refactor/update_readme
Jan 29, 2026
Merged

docs: prioritize ADK in README feature highlights#719
shentongmartin merged 1 commit intomainfrom
refactor/update_readme

Conversation

@shentongmartin
Copy link
Contributor

Summary

This PR reorders the README documentation to put the Agent Development Kit (ADK) in a more prominent position, reflecting its importance as a primary feature of Eino.

Changes

Location Change
What Eino provides list Moved ADK to 2nd position (after components, before composition)
Key Features section Moved ADK section above Orchestration section

Rationale

The ADK package provides high-level abstractions that most users will interact with first when building AI agents. By positioning it before the lower-level composition/orchestration framework, new users can more easily discover the recommended starting point for agent development.

Files Changed

  • README.md - English version
  • README.zh_CN.md - Chinese version

概要

本 PR 调整了 README 文档的顺序,将 智能体开发套件(ADK) 放在更显眼的位置,以体现其作为 Eino 主要特性的重要性。

变更

位置 变更内容
Eino 提供的价值 列表 将 ADK 移至第 2 位(组件之后,编排之前)
关键特性 章节 将 ADK 章节移至编排章节之前

原因

ADK 包提供了大多数用户在构建 AI 智能体时首先会接触的高级抽象。将其放在较低级别的编排框架之前,可以让新用户更容易发现智能体开发的推荐起点。

@codecov
Copy link

codecov bot commented Jan 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.80%. Comparing base (210b528) to head (02df79d).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #719      +/-   ##
==========================================
- Coverage   81.85%   81.80%   -0.05%     
==========================================
  Files         129      129              
  Lines       12419    12419              
==========================================
- Hits        10165    10159       -6     
- Misses       1500     1504       +4     
- Partials      754      756       +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.

- Move ADK above composition framework in 'What Eino provides' list
- Reorder 'Key Features' section to put ADK before Orchestration
- Update both English and Chinese README files consistently
- Adjust intro text to better position ADK as a primary feature

Change-Id: I27b41b8051f45900af63290f3c92711e2120b0fe
@shentongmartin shentongmartin merged commit 0077549 into main Jan 29, 2026
17 of 18 checks passed
@shentongmartin shentongmartin deleted the refactor/update_readme branch January 29, 2026 01:15
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