Skip to content

docs: prepare 0.6.4 runtime platform review candidate#13

Merged
AgentArcLab merged 20 commits into
mainfrom
review/public-runtime-platform-positioning
Jun 10, 2026
Merged

docs: prepare 0.6.4 runtime platform review candidate#13
AgentArcLab merged 20 commits into
mainfrom
review/public-runtime-platform-positioning

Conversation

@AgentArcLab

@AgentArcLab AgentArcLab commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

概要

这是 KsADK 0.6.4 的公开 review 候选,不是发布动作。

  • 将公开定位统一为 Agent Runtime Platform,覆盖 README、文档首页、包元数据和 CHANGELOG
  • README 收敛为简洁入口页:项目定位、30 秒上手、真实 CLI/Web UI 图、架构图、文档/样例/贡献入口
  • README 不再承载 0.6.x 版本重点或细粒度功能说明;版本历史放在 CHANGELOG.md 和 GitHub Releases,配置细节放在文档站
  • 文档站新增 Getting Started 下的 Why KsADKArchitectureComparison 三个认知入口页,并接入中英文导航
  • Comparison 页按事实说明 Google ADK、LangGraph、OpenAI Agents SDK、VEADK、AgentRun 与 KsADK 的互补关系,不使用误导性能力打分榜
  • 新增 ksadk.markdown.repair_markdown(text, enabled=True) 可选业务侧 Markdown 形态修复工具;默认关闭,runtime 不自动改写 raw LLM output
  • 将公开默认线上 region 示例统一为 KSYUN_REGION=cn-beijing-6
  • 保留真实浅色 CLI 截图、真实本地 Web UI 截图和 GIF、架构图素材
  • 增加公开定位、README 简洁性、敏感词、视觉资产、导航、Markdown 修复默认关闭等回归测试

Review Checklist

  • README 第一屏能明确表达 Build agents once. Run them anywhere.Agent Runtime Platform
  • 默认 README 中文优先,英文 README 作为补充入口
  • README 足够简洁,不再列 0.6.3/0.6.4 changelog 或细粒度配置内容
  • 文档站有独立 Why KsADKArchitectureComparison 页面
  • Comparison 页符合事实,不把 ADK、VEADK、OpenAI Agents SDK 等能力写错
  • Markdown 修复能力是业务侧显式开启,默认关闭,运行时不自动规范化模型输出
  • 公开材料没有 pre-online、内部 endpoint/header、真实 token、真实 Skill Space ID 或内网 runbook
  • KSYUN_REGION=cn-beijing-6 作为公开默认线上 region 示例出现
  • CHANGELOG 明确 0.6.4 仍为 Unreleased,发布动作需用户 review 后单独确认

已验证

  • GitHub Actions 全绿
    • CI / test passed
    • Release Check / artifacts passed
    • Secret Pattern Audit / scan passed
    • CodeQL / analyze passed
  • make public-preflight
    • public branch policy passed
    • secret audit passed
    • public source audit passed: 1087 checked, 0 violations
    • public tests: 61 passed
    • MkDocs strict docs build passed
    • uv build succeeded
    • twine check PASSED
    • sdist/wheel audit: 0 violations
  • uv run pytest tests/test_markdown_repair.py tests/test_public_positioning_docs.py -q
    • 22 passed
  • uv run mkdocs build --strict
    • passed
  • make open-source-smoke-install
    • clean venv installed dist/ksadk-0.6.4-py3-none-any.whl
    • agentengine --help and agentengine web --help are available
  • make public-publish-check
    • docs: HTTP 200
    • GitHub Release history present: v0.6.1, v0.6.2, v0.6.3
    • GitHub Release body audit: v0.6.1 / v0.6.2 / v0.6.3 未发现 pre-online、内部 endpoint 或私有 header
    • PyPI ksadk latest: 0.6.3
    • PyPI ksadk==0.6.4: not found, version slot clear
    • PyPI agentengine-sdk-python latest: 0.6.2
    • PyPI agentengine-sdk-python==0.6.4: not found, version slot clear

相关 PR

  • ksadk-samples#2: 场景优先样例入口与主推 LangGraph toolsets demo

Review 通过后的发布步骤

这些步骤只在用户明确批准后执行:

  1. 确认本 PR 与 ksadk-samples#2 均 green 且 review 通过。
  2. 将本 PR从 Draft 标记为 Ready,并合并到 GitHub main
  3. 在公开工作树同步 github/main,重新执行 make public-preflight
  4. 执行 make public-publish-check,确认 GitHub Pages / Release / PyPI pre-publish 状态。
  5. 在 GitHub main 对应提交上执行 make public-release-tag V=0.6.4,并推送 v0.6.4 tag。
  6. 基于同一公开提交创建 GitHub Release,保留历史 releases。
  7. 通过仓库 Makefile 发布 ksadk==0.6.4 到 PyPI,不手写绕过上传流程。
  8. ksadk==0.6.4 发布并可查询后,再上传本地已验证的 agentengine-sdk-python==0.6.4 别名包 wheel。
  9. 发布后复核 PyPI、GitHub Release、Pages、README 渲染、主包安装 smoke 和别名包安装 smoke。

发布边界

本 PR 合并前仅用于 review。合并、tag、GitHub Release、PyPI 上传、Pages 发布和别名包上传都需要单独确认。

Comment thread scripts/check_publication_state.py Fixed
@AgentArcLab

Copy link
Copy Markdown
Contributor Author

0.6.4 public candidate update:

  • Refined README badge layout: language links are separate; Docs / PyPI / Ask Zread / Apache-2.0 badges are centered together.
  • Kept README Chinese-first and concise; removed version/changelog/release content from the README body.
  • Switched docs homepage to the wide CLI image and constrained screenshot/GIF/architecture image widths.
  • Moved detailed ecosystem comparison expectations to the comparison page; homepage now keeps a shorter positioning summary.
  • Removed the invalid maicp endpoint from the public candidate and tests; aicp.inner.api.ksyun.com, aicp.internal.api.ksyun.com, and aicp.api.ksyun.com remain allowed.
  • Verified wheel contents include ksadk.tools.gateway, ksadk.skills.service_env, ksadk.toolsets, ksadk.markdown, and ksadk_runtime_common.

Validation:

  • make public-preflight: passed
  • make open-source-smoke-install: passed
  • GitHub PR checks: CodeQL / analyze / artifacts / scan / test all passed
  • ksadk-samples make public-preflight: passed
  • agentengine-images make audit: passed

No release/tag/PyPI publish has been performed; 0.6.4 still needs maintainer review before publication.

@AgentArcLab AgentArcLab marked this pull request as ready for review June 10, 2026 12:14
@AgentArcLab AgentArcLab merged commit 1115078 into main Jun 10, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants