Skip to content

文档路径英文化迁移

背景

docs/ 当前存在中文目录名和文件名,VitePress 会据此生成中文 URL。目标是在不翻译文档正文的前提下,将 docs/ 下所有中文目录和中文文件名统一迁移为英文路径,并同步更新仓库内引用与文档站导航。

范围与验收

  • [x] docs/ 下的目录名和文件名全部为 ASCII,文件名统一使用英文 kebab-case
  • [x] Markdown 正文保持中文,仅更新链接、路径引用和目录登记。
  • [x] 仓库内不再引用旧中文文档路径。
  • [x] VitePress 生成的页面 URL 全部为英文路径。
  • [x] npm run docs:checknpm run build:docs 通过。

实施步骤

  1. 建立完整且唯一的中英路径映射,先迁移目录,再迁移文件。
  2. 机械更新 Markdown、JSON、配置、脚本和源码中的旧路径引用。
  3. 更新 docs/catalog.json、各级索引和 VitePress 导航配置。
  4. 扫描残留中文路径并执行文档与站点构建验证。

风险与回滚

路径迁移会使旧中文 URL 失效,并可能影响仓库外部保存的深层链接。本次不保留旧路径兼容层;若验证失败,按完整路径映射反向恢复文件名和引用,不回滚其他工作区改动。

进度

  • [x] 建立迁移计划。
  • [x] 完成路径映射与重命名。
  • [x] 更新全部引用与目录登记。
  • [x] 完成文档和 VitePress 构建验证。

决策日志

日期决策原因
2026-08-20使用英文目录与 kebab-case 文件名保证静态站点 URL 稳定、可读且无需百分号编码。
2026-08-20不翻译正文,不保留旧中文路径兼容重定向保持内容语义不变,并遵守不保留旧兼容层的规则。
2026-08-20VitePress 侧栏标题继续读取中文一级标题路径英文化不应改变文章标题和中文阅读体验。

基于 AGPL-3.0-or-later 发布