执行摘要
- 一句话:为 README 与 docs 首页补上致谢 logo 墙
- 推荐动作:建议快速浏览而非深读:该 PR 是干净利落的文档补齐,主要价值在于展示了 README 与 docs 站之间复用同一静态资产的两种引用策略(绝对 raw URL 对站点相对路径)。如果团队后续想避免两条引用路径漂移,可以在 CI 中增加对
acknowledgment.png 的 URL 存在性检查,或让 README 也改用相对路径。
功能与动机
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 背后硬件、云、模型实验室、智能体基础设施与学术界的贡献团队。
实现拆解
- 替换 README 占位符:在
README.md 的 Acknowledgment 小节,将 <!-- TODO: acknowledgment figure --> 占位符替换为一段导语“Miles is shaped by the teams...”加居中 <div> 包裹的 <img>。导语先交代 logo 墙覆盖硬件、云、模型实验室、智能体基础设施与学术界,图片复用 README 顶部 Miles logo 的 raw.githubusercontent.com 绝对 URL,保证 README 被镜像到其他平台时仍可渲染。
- 补齐 docs 首页致谢区:在
docs/index.md 的 Contribute 小节前插入 Acknowledgment 小节,先保留 README 中已有的 slime / SGLang / Megatron-LM / torch_memory_saver 致谢文案,再放同一导语与 logo 墙;此处图片改用站点相对路径 /assets/images/acknowledgment.png,适配文档站部署。
- 引入共享图片资产:新增
docs/assets/images/acknowledgment.png,尺寸 5600x2544、约 870 KB,低于仓库 check-added-large-files 的 1000 KB 限制;README 与 docs 两个入口引用同一张图,后续更新致谢名单只需替换该文件。
- 验证与配套:本地
mint dev 启动文档站后首页与图片均返回 200,章节顺序符合预期;pre-commit run --all-files 全部 14 个 hook 通过。本 PR 只改文档与静态资产,无测试、配置、schema 或部署层面的配套改动。
关键文件:
README.md(模块 文档入口;类别 docs;类型 documentation): 替换 TODO 占位符为居中 logo 墙,是本次改动最主要的视觉呈现载体,决定了 README 在 GitHub 上的致谢展示效果。
docs/index.md(模块 文档首页;类别 docs;类型 documentation): docs 落地页此前完全没有 Acknowledgment 章节,本次在 Contribute 前新增致谢区,是整个文档站点信息架构的补充。
docs/assets/images/acknowledgment.png(模块 静态资产;类别 other;类型 asset): 新增的共享致谢 logo 墙图片,README 与 docs 首页两个入口复用同一资产,是本次变更的实体载体。
关键符号:未识别
评论区精华
本 PR 未产生实质技术讨论。claude[bot] 的自动评论仅提示该仓库配置了人工 code review(可评论 @claude review 触发),随后维护者 guapisolo 直接批准,批准附言为空。因此不存在争议点、设计权衡或未解决的疑虑,也不需要在实现层面做进一步取舍。
- 无实质技术讨论,仅自动评审与批准 (other): 无设计权衡或争议点,PR 已合入;自动化评论不影响合并。
风险与影响
- 风险:
- 外部链接依赖:
README.md 中的图片使用 https://raw.githubusercontent.com/radixark/miles/main/docs/assets/images/acknowledgment.png,路径固定在 main 分支;若图片未来被移动、重命名或分支保护策略改变,镜像 README 的平台会出现 404 图片,需要与当前站点相对路径引用保持同步。
- 站点路径假设:
docs/index.md 引用 /assets/images/acknowledgment.png,依赖文档站部署时把 docs/assets 挂载为站点 /assets;若本地构建或第三方镜像的挂载方式不同,图片会失效。
- 静态资源体积:新增 870 KB PNG 进入 Git 历史,属于一次性体积增量;后续若替换更复杂的致谢名单应注意
check-added-large-files 的 1000 KB 阈值。
- 回归面:本 PR 不触碰任何 Python 源码、训练链路、配置或测试,因此不存在运行时回归、性能或安全风险。
- 影响:影响范围集中在对外呈现:GitHub 首页 README 与官网 landing page 会同步显示致谢 logo 墙,提升合作方品牌露出,并让读者理解 Miles 的生态来源。对内部系统的训练、调度、回滚等模块零影响;团队后续维护致谢名单只需替换单一图片文件,README 与 docs 两条引用会自动更新。由于是文档级变更,影响程度低,不改变任何产品行为。
- 风险标记:外部图片链接依赖, 静态资源体积, 纯文档变更
关联脉络
- PR #2594 docs: name the dense variant in the Qwen3.8 model-table rows: 同一文件
docs/index.md 的最近一次文档修订(Qwen3.8 模型表命名),与本次新增 Acknowledgment 小节同属 docs 首页维护。
- PR #2565 docs: fold Welcome into the User Guide tab and lead with it: 重构 docs 导航并调整 landing page 结构,与本次在 landing page 插入新章节属于同一条信息架构演进线。
- PR #2523 docs: delete the FAQ page: 删除 FAQ 并清理导航,体现近期对文档站点持续做入口规整。
参与讨论