Skip to content

Commit a4de1ee

Browse files
committed
docs: showcase runtime platform experience
1 parent d91e321 commit a4de1ee

16 files changed

Lines changed: 614 additions & 110 deletions

CHANGELOG.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77

88
## [0.6.4] - Unreleased
99

10-
### 亮点
10+
### 重点
1111

12-
- **公开定位重构**:将项目首页、README 和文档首页从传统 SDK 口径调整为 Agent Runtime Platform,补齐 Why KsADK、30 秒体验、架构图、对比表、Deployment、Observability 和 Community。
13-
- **中文优先与视觉化首页**:默认 README 和中文文档首页改为中文主叙述,新增可维护的架构图 PNG/SVG 与本地调试演示 GIF,让首次访问者先看到运行时平台边界和 Web UI 最终效果。
12+
- **项目定位重构**:将 README、文档首页和包元数据统一为 Agent Runtime Platform 口径,突出统一运行、浏览器调试、OpenAI-Compatible API、Sandbox、部署和可观测价值。
13+
- **中文优先首页**:默认 README 与中文文档首页使用中文主叙述,英文 README 作为补充入口保留,避免公开首页变成英文优先材料。
14+
- **真实视觉资产**:首页首屏使用真实浅色 CLI 截图,30 秒体验后展示真实本地 Web UI 截图和 GIF;演示由本地 deterministic LangGraph Runner 生成,不依赖外部模型或云环境。
1415
- **文档信息架构调整**:MkDocs 导航改为 Getting Started / Build / Run / Deploy / Observe / Extend / Reference,更贴近开发者完成任务的路径。
1516
- **Samples 场景入口对齐**`ksadk-samples` 根 README 改为场景优先,真实映射 Knowledge Assistant、Workflow Agent、Tool-Using Agent 和 Memory-aware Agent;尚未实现的场景只进入 Roadmap。
16-
- **公开元数据修复**:更新 PyPI summary 和包内简介为 Agent Runtime Platform 定位,为后续补丁发布准备干净的 long description。
1717
- **默认线上地域说明**:公开 README 和文档首页使用 `KSYUN_REGION=cn-beijing-6` 作为线上默认 region 示例,避免用户把非公开或内网配置照搬到公开 demo。
1818

1919
### 修复
@@ -22,10 +22,12 @@
2222
- 将公开定位、视觉资产存在性、中文优先标题、敏感词扫描和 README 场景入口要求纳入本地门禁,降低后续发布材料回退风险。
2323
-`agentengine-sdk-python` 别名包版本占用检查纳入 `public-publish-check`,避免主包与别名包发布状态不一致。
2424

25-
### 发布说明
25+
### 发布治理
2626

2727
- 这是修复 0.6.3 公开页面和 PyPI 元数据口径的补丁版本草案;已发布到 PyPI 的 0.6.3 元数据不可覆盖,因此后续需要通过新版本修复。
2828
- 0.6.4 在用户 review 通过前不创建 tag、不发布 GitHub Release,也不上传 PyPI。
29+
- GitHub Release 页面必须保留历史版本 `v0.6.1``v0.6.2``v0.6.3`;0.6.4 只能新增 release,不能清理历史条目。
30+
- 公开 CHANGELOG 不记录非公开环境名、内网 endpoint、真实账号、真实 Skill Space ID 或临时凭证;这些只允许出现在内部联调记录里。
2931

3032
## [0.6.3] - 2026-06-09
3133

README.en.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Candidate version: `0.6.4` (Unreleased, pending user review; use PyPI and GitHub
1818
- Serverless Deployment
1919
- Hermes & OpenClaw Runtime
2020

21-
![KsADK local debugging demo](https://kingsoftcloud.github.io/ksadk-python/assets/ksadk-local-debugging-demo.gif)
21+
![Real KsADK CLI screenshot: agentengine -h](https://kingsoftcloud.github.io/ksadk-python/assets/ksadk-runtime-platform-hero.png)
2222

2323
## Why KsADK
2424

@@ -56,6 +56,12 @@ Open the local browser debugging UI:
5656
agentengine web . --no-open
5757
```
5858

59+
The demo below is generated from the real local Web UI. It uses a deterministic LangGraph Runner and does not call an external model or cloud service, while still exercising local FastAPI, Responses streaming, tool calls, thinking output, and session status.
60+
61+
![Real KsADK Web UI debugging screenshot](https://kingsoftcloud.github.io/ksadk-python/assets/ksadk-web-ui-screenshot.png)
62+
63+
![Real KsADK Web UI debugging GIF](https://kingsoftcloud.github.io/ksadk-python/assets/ksadk-local-debugging-demo.gif)
64+
5965
If your model provider is not the default OpenAI endpoint, also set:
6066

6167
```bash

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ KsADK 是面向 AI Agent 的运行时平台(Agent Runtime Platform)。你可
2020
- Serverless 部署(Serverless Deployment)
2121
- Hermes 与 OpenClaw 运行时
2222

23-
![KsADK 本地调试演示](https://kingsoftcloud.github.io/ksadk-python/assets/ksadk-local-debugging-demo.gif)
23+
![KsADK 真实 CLI 截图:agentengine -h](https://kingsoftcloud.github.io/ksadk-python/assets/ksadk-runtime-platform-hero.png)
2424

2525
## 为什么需要 KsADK
2626

@@ -58,6 +58,12 @@ agentengine run -i
5858
agentengine web . --no-open
5959
```
6060

61+
下面是脚本生成的真实本地 Web UI 演示:使用 deterministic LangGraph Runner,不连接外部模型或云环境,但完整走本地 FastAPI、Responses streaming、工具调用、思考过程和会话状态链路。
62+
63+
![KsADK 真实 Web UI 调试截图](https://kingsoftcloud.github.io/ksadk-python/assets/ksadk-web-ui-screenshot.png)
64+
65+
![KsADK 真实 Web UI 调试 GIF](https://kingsoftcloud.github.io/ksadk-python/assets/ksadk-local-debugging-demo.gif)
66+
6167
如果你的模型服务不是默认 OpenAI endpoint,再额外配置:
6268

6369
```bash

README.zh-CN.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ KsADK 是面向 AI Agent 的运行时平台(Agent Runtime Platform)。你可
2020
- Serverless 部署(Serverless Deployment)
2121
- Hermes 与 OpenClaw 运行时
2222

23-
![KsADK 本地调试演示](https://kingsoftcloud.github.io/ksadk-python/assets/ksadk-local-debugging-demo.gif)
23+
![KsADK 真实 CLI 截图:agentengine -h](https://kingsoftcloud.github.io/ksadk-python/assets/ksadk-runtime-platform-hero.png)
2424

2525
## 为什么需要 KsADK
2626

@@ -58,6 +58,12 @@ agentengine run -i
5858
agentengine web . --no-open
5959
```
6060

61+
下面是脚本生成的真实本地 Web UI 演示:使用 deterministic LangGraph Runner,不连接外部模型或云环境,但完整走本地 FastAPI、Responses streaming、工具调用、思考过程和会话状态链路。
62+
63+
![KsADK 真实 Web UI 调试截图](https://kingsoftcloud.github.io/ksadk-python/assets/ksadk-web-ui-screenshot.png)
64+
65+
![KsADK 真实 Web UI 调试 GIF](https://kingsoftcloud.github.io/ksadk-python/assets/ksadk-local-debugging-demo.gif)
66+
6167
如果你的模型服务不是默认 OpenAI endpoint,再额外配置:
6268

6369
```bash
29.6 KB
Loading
997 KB
Loading
308 KB
Loading
92 KB
Loading

public-docs/index.en.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ KsADK is the Agent Runtime Platform for AI agents.
66

77
Build with Google ADK, LangGraph, LangChain, or DeepAgents. Run, debug, expose, observe, and deploy those agents through one unified runtime experience.
88

9-
![KsADK local debugging demo](assets/ksadk-local-debugging-demo.gif)
9+
![Real KsADK CLI screenshot: agentengine -h](assets/ksadk-runtime-platform-hero.png)
1010

1111
=== "Install"
1212

@@ -63,6 +63,12 @@ Open the local Web UI:
6363
agentengine web . --no-open
6464
```
6565

66+
The demo below is generated from the real local Web UI. It uses a deterministic LangGraph Runner and does not call an external model or cloud service, while still exercising local FastAPI, Responses streaming, tool calls, thinking output, and session status.
67+
68+
![Real KsADK Web UI debugging screenshot](assets/ksadk-web-ui-screenshot.png)
69+
70+
![Real KsADK Web UI debugging GIF](assets/ksadk-local-debugging-demo.gif)
71+
6672
If your model provider is not the default OpenAI endpoint, also set:
6773

6874
```bash

public-docs/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ KsADK 是面向 AI Agent 的运行时平台(Agent Runtime Platform)。
66

77
你可以继续使用 Google ADK、LangGraph、LangChain 或 DeepAgents 编写业务 Agent,再用 KsADK 获得统一的本地运行、浏览器调试、OpenAI-Compatible API、沙箱执行、部署和可观测体验。
88

9-
![KsADK 本地调试演示](assets/ksadk-local-debugging-demo.gif)
9+
![KsADK 真实 CLI 截图:agentengine -h](assets/ksadk-runtime-platform-hero.png)
1010

1111
=== "安装"
1212

@@ -63,6 +63,12 @@ agentengine run -i
6363
agentengine web . --no-open
6464
```
6565

66+
下面是脚本生成的真实本地 Web UI 演示:使用 deterministic LangGraph Runner,不连接外部模型或云环境,但完整走本地 FastAPI、Responses streaming、工具调用、思考过程和会话状态链路。
67+
68+
![KsADK 真实 Web UI 调试截图](assets/ksadk-web-ui-screenshot.png)
69+
70+
![KsADK 真实 Web UI 调试 GIF](assets/ksadk-local-debugging-demo.gif)
71+
6672
如果使用非默认 OpenAI endpoint,再额外设置:
6773

6874
```bash

0 commit comments

Comments
 (0)