执行摘要
本 PR 是文档站一致性清理:删除 docs/docs.json 中 navbar.primary 的 Contact 按钮(指向 mailto:miles@radixark.ai),使文档导航栏不再独家暴露该邮箱。改动仅 1 个文件、净减 5 行,无运行时逻辑变更,评审已通过并合入 milestone v0.1。
功能与动机
README 的 Contact Us 段落在 commit 780c068cb 中已被移除,但 docs 站导航栏的 primary 按钮仍指向同一个邮箱地址,成为全仓库唯一仍在对外展示该地址的位置。PR body 明确说明动机:
这移除了该按钮,使两者保持一致。
同时 PR 明确划定了职责边界:CODE_OF_CONDUCT.md 仍保留该邮箱作为行为准则举报联系方式,因其不属于 docs 站点,故不在本次变更范围内。
实现拆解
- 定位变更入口:
docs/docs.json 是 Mintlify 文档站的站点配置,导航栏由 navbar 键控制,其中 primary 为可选的 CTA 按钮区。
- 删除按钮配置:移除
navbar.primary 对象(type: button、label: Contact、href: mailto:miles@radixark.ai),净删 6 行、净增 1 行,属于纯配置删除。
- 保留其他导航项:
navbar.links 中的 GitHub 链接不做改动,保证用户仍能通过文档站直达仓库。
- 配套校验:无自动化测试;作者在 checklist 中手动确认 JSON 合法且符合 Mintlify schema(
navbar.primary 为可选字段)。仓库现有 tests/fast/doc/test_sync_example_docs.py 与本次配置无交互,未受影响。
关键源码片段
docs/docs.json
唯一变更文件;删除 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 中的邮箱因承担举报职责且不属于文档站,保持不变。
}
}
评论区精华
无实质讨论。PR 获得 Zhichenzzz 的 APPROVED 评审,没有任何代码评论;作者本人兼合入者。变更简单明确,评审未提出疑虑。
风险与影响
- 外联入口收窄:docs 站不再展示联系邮箱,用户只能通过 GitHub 链接进入仓库提出 issue。若项目后续想重新开放邮箱联系,需要在 README 或 docs 中同步恢复。
- 渲染回归风险:若 Mintlify 某些主题强依赖
navbar.primary,删除可能导致导航栏渲染异常;作者已对照 schema 确认该字段可选,风险极低。
- 无自动化校验:对
docs.json 与 Mintlify schema 的一致性检查依赖人工,后续若误改其他可选字段,缺少 CI 兜底。
- 影响范围:仅文档站导航栏渲染,无训练、rollout、session 等任何运行时逻辑受影响。
关联脉络
本 PR 是移除外联邮箱链路的收尾:PR #2383 重写 README 时删除了 Contact Us 段落(commit 780c068cb),本 PR 随即清理 docs 导航栏中同一邮箱的唯一剩余暴露点。同期 PR #2489 与 #2491 都在调整 docs/docs.json 的导航结构(标签化侧栏分组、Environments 归入 User Guide),反映出文档站导航配置正处于一轮集中整理中,本 PR 属于其中一小步。
参与讨论