Prhub

#2487 docs: drop the Contact button from the docs navbar

原始 PR 作者 nblintao 合并时间 2026-08-14 05:03 文件变更 1 提交数 1 评论 0 代码增减 +1 / -6

执行摘要

删除 docs 导航栏 Contact 按钮,与 README 保持一致

PR body 说明:README 的 Contact Us 段落在 commit 780c068cb 中删除后,docs 导航栏成为唯一暴露 miles@radixark.ai 的地方,为了保持两部分一致,移除此按钮。CODE_OF_CONDUCT.md 仍保留该地址作为行为准则举报联系方式,因其不属于文档站,故不在本次变更范围内。

不值得精读,属于琐碎的一致性清理。值得关注的决策点:移除对外联系方式时,应同步排查所有暴露同一信息的入口(README、docs、CODE_OF_CONDUCT),并明确各入口职责边界;删除可选配置字段前,应先核对上游 schema 以确认字段确实可选。

讨论亮点

无实质讨论。PR 获得 Zhichenzzz 的 APPROVED 评审,没有任何代码评论;作者本人兼合入者。变更简单明确,评审未提出疑虑。

实现拆解

  1. 定位变更入口:docs/docs.json 是 Mintlify 文档站的站点配置,导航栏由 navbar 键控制,其中 primary 为可选的 CTA 按钮区。
  2. 删除按钮配置:移除 navbar.primary 对象(type: button、label: Contact、href: mailto:miles@radixark.ai),净删 6 行、净增 1 行,属于纯配置删除。
  3. 保留其他导航项:navbar.links 中的 GitHub 链接不做改动,保证用户仍能通过文档站直达仓库。
  4. 配套校验:无自动化测试;作者在 checklist 中手动确认 JSON 合法且符合 Mintlify schema(navbar.primary 为可选字段)。仓库现有 tests/fast/doc/test_sync_example_docs.py 与本次配置无交互,未受影响。
文件 模块 状态 重要度
docs/docs.json 文档站 modified 3.01

关键源码片段

docs/docs.json configuration

唯一变更文件;删除 navbar.primary 的 Contact 按钮,是文档站导航配置的核心位置。

// docs/docs.json —— Mintlify 文档站站点配置(变更后的 navbar 部分)
{
  "navbar": {
    "links": [
      {
        "type": "github",
        "href": "https://github.com/radixark/miles"
      }
    ]
    // 原 navbar.primary 按钮(type: button, label: Contact,
    // href: mailto:miles@radixark.ai)已在本 PR 中删除。
    // 删除原因:README 的 Contact Us 段落已随 commit 780c068cb 移除,
    // 该按钮成为唯一暴露 miles@radixark.ai 的位置,与全局信息不一致。
    // 保留 GitHub 链接作为文档站唯一的外联入口;
    // CODE_OF_CONDUCT.md 中的邮箱因承担举报职责且不属于文档站,保持不变。
  }
}

评论区精华

没有提炼出高价值讨论线程

当前评论区没有形成足够清晰的争议点或结论,后续有更多讨论时会体现在这里。

风险与影响

  • 外联入口收窄:docs 站不再展示联系邮箱,用户只能通过 GitHub 链接进入仓库提出 issue。若项目后续想重新开放邮箱联系,需要在 README 或 docs 中同步恢复。
  • 渲染回归风险:若 Mintlify 某些主题强依赖 navbar.primary,删除可能导致导航栏渲染异常;作者已对照 schema 确认该字段可选,风险极低。
  • 无自动化校验:对 docs.json 与 Mintlify schema 的一致性检查依赖人工,后续若误改其他可选字段,缺少 CI 兜底。
  • 影响范围:仅文档站导航栏渲染,无训练、rollout、session 等任何运行时逻辑受影响。
  • 用户:文档站导航栏不再显示 Contact 按钮,联系入口收窄为 GitHub 仓库链接。
  • 系统:无运行时影响,仅影响 Mintlify 文档站导航渲染。
  • 团队:作为移除外联渠道系列改动的一部分,消除了同一邮箱在 README 与 docs 两处重复暴露的不一致;属于 milestone v0.1 下的清理项。
外联入口唯一化 缺少自动化校验

关联 Issue

未识别关联 Issue

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

完整报告

参与讨论