Prhub

#2603 docs: add the acknowledgment logo wall to the README and docs landing page

原始 PR 作者 Zhichenzzz 合并时间 2026-08-18 17:09 文件变更 3 提交数 1 评论 0 代码增减 +21 / -2

执行摘要

为 README 与 docs 首页补上致谢 logo 墙

README 的 Acknowledgment 章节自创建起就带着 <!-- TODO: acknowledgment figure --> 占位符,一直缺少实际的合作组织展示;docs/index.md 首页则完全没有 Acknowledgment 章节。PR body 明确指出要“Fills in the placeholder the README has carried since its Acknowledgment section was written, and gives the docs landing page an Acknowledgment section it did not have”,目的是同时补齐 README 与文档落地页的致谢呈现,让读者了解 Miles 背后硬件、云、模型实验室、智能体基础设施与学术界的贡献团队。

建议快速浏览而非深读:该 PR 是干净利落的文档补齐,主要价值在于展示了 README 与 docs 站之间复用同一静态资产的两种引用策略(绝对 raw URL 对站点相对路径)。如果团队后续想避免两条引用路径漂移,可以在 CI 中增加对 acknowledgment.png 的 URL 存在性检查,或让 README 也改用相对路径。

讨论亮点

本 PR 未产生实质技术讨论。claude[bot] 的自动评论仅提示该仓库配置了人工 code review(可评论 @claude review 触发),随后维护者 guapisolo 直接批准,批准附言为空。因此不存在争议点、设计权衡或未解决的疑虑,也不需要在实现层面做进一步取舍。

实现拆解

  1. 替换 README 占位符:在 README.md 的 Acknowledgment 小节,将 <!-- TODO: acknowledgment figure --> 占位符替换为一段导语“Miles is shaped by the teams...”加居中 <div> 包裹的 <img>。导语先交代 logo 墙覆盖硬件、云、模型实验室、智能体基础设施与学术界,图片复用 README 顶部 Miles logo 的 raw.githubusercontent.com 绝对 URL,保证 README 被镜像到其他平台时仍可渲染。
  2. 补齐 docs 首页致谢区:在 docs/index.md 的 Contribute 小节前插入 Acknowledgment 小节,先保留 README 中已有的 slime / SGLang / Megatron-LM / torch_memory_saver 致谢文案,再放同一导语与 logo 墙;此处图片改用站点相对路径 /assets/images/acknowledgment.png,适配文档站部署。
  3. 引入共享图片资产:新增 docs/assets/images/acknowledgment.png,尺寸 5600x2544、约 870 KB,低于仓库 check-added-large-files 的 1000 KB 限制;README 与 docs 两个入口引用同一张图,后续更新致谢名单只需替换该文件。
  4. 验证与配套:本地 mint dev 启动文档站后首页与图片均返回 200,章节顺序符合预期;pre-commit run --all-files 全部 14 个 hook 通过。本 PR 只改文档与静态资产,无测试、配置、schema 或部署层面的配套改动。
文件 模块 状态 重要度
README.md 文档入口 modified 2.6
docs/index.md 文档首页 modified 2.43
docs/assets/images/acknowledgment.png 静态资产 added 2.17

分析完成后,这里会展示 LLM 生成的相对完整源码片段和详细注释。

评论区精华

无实质技术讨论,仅自动评审与批准 other

claude[bot] 的自动化评论提示仓库配置了人工 code review,可评论 @claude review 触发一次性或持续评审;随后维护者 guapisolo 直接批准,未留下任何代码内评论。

结论:无设计权衡或争议点,PR 已合入;自动化评论不影响合并。 · 已解决

风险与影响

  1. 外部链接依赖:README.md 中的图片使用 https://raw.githubusercontent.com/radixark/miles/main/docs/assets/images/acknowledgment.png,路径固定在 main 分支;若图片未来被移动、重命名或分支保护策略改变,镜像 README 的平台会出现 404 图片,需要与当前站点相对路径引用保持同步。
  2. 站点路径假设:docs/index.md 引用 /assets/images/acknowledgment.png,依赖文档站部署时把 docs/assets 挂载为站点 /assets;若本地构建或第三方镜像的挂载方式不同,图片会失效。
  3. 静态资源体积:新增 870 KB PNG 进入 Git 历史,属于一次性体积增量;后续若替换更复杂的致谢名单应注意 check-added-large-files 的 1000 KB 阈值。
  4. 回归面:本 PR 不触碰任何 Python 源码、训练链路、配置或测试,因此不存在运行时回归、性能或安全风险。

影响范围集中在对外呈现:GitHub 首页 README 与官网 landing page 会同步显示致谢 logo 墙,提升合作方品牌露出,并让读者理解 Miles 的生态来源。对内部系统的训练、调度、回滚等模块零影响;团队后续维护致谢名单只需替换单一图片文件,README 与 docs 两条引用会自动更新。由于是文档级变更,影响程度低,不改变任何产品行为。

外部图片链接依赖 静态资源体积 纯文档变更

关联 Issue

未识别关联 Issue

当前没有检测到明确关联的 Issue 链接,后续同步到相关引用后会出现在这里。

完整报告

参与讨论