Skip to content

文档站点

翻译说明: 本页是与 英文源规格 一一对应的机器辅助翻译。代码、协议字段和标识符保持原文;如翻译与英文源事实有歧义,以英文版本为准。

状态

已接受。请参阅 ADR 0079

决定

docs/ 目录是 pnpm 内的独立 VitePress 项目 工作区。 Markdown 仍然是事实的来源; VitePress 供应本地 开发服务器,静态构建,本地搜索索引,代码突出显示,以及 版本化的导航 shell。

该站点公开了两个区域设置入口点:

  • / — 英语优先的完整文档导航。
  • /zh-CN/ — 简体中文方向以及路径对路径伴侣 docs/spec/ 下每个文档的页面。

对于根目录为 docsdocs/vercel.json 的 Vercel 部署 将 VitePress 构建输出声明为 .vitepress/dist 并启用 Vercel cleanUrls 路由。这会保留无扩展的链接,例如 /spec/README/adr/README 在直接页面刷新后工作而不是变成静态 托管 404。

现有 spec/adr/project/ 和指南 Markdown 文件保持不变 因此存储库链接和评论历史记录保持稳定。中文规格页 生活在 docs/zh-CN/spec/ 下,相对路径与英语相同 来源。每个翻译的页面都链接到规范的英语页面并保留 代码、协议字段和标识符不变。

本地命令

bash
pnpm docs:dev
pnpm docs:build
pnpm docs:preview
pnpm docs:check

生产构建是静态的,不需要运行时服务。这 网站可能会在开发或部署期间加载 Google Fonts,但内容 和搜索索引由 VitePress 在本地生成。

pnpm docs:check 验证每个英文规范都有匹配的 带有标题和规范来源通知的中文 Markdown 文件。 VitePress 生产构建然后验证渲染的路线和内部链接。

内容规则

  1. 英语仍然是规范、ADR、代码的规范源语言 标识符和协议术语。
  2. 每个英文规范同时有一个简体中文配套 /zh-CN/spec/ 下的相对路径;两个语言环境都暴露相同的部分并且 阅读顺序。 3.中文页面翻译完整的散文,链接回英文源, 并逐字保留代码、协议字段和标识符。措辞时 不同的是,英文合同仍然具有权威性。 4.侧边栏源自Markdown树,因此新的规范不能 被意外地从深度导航中遗漏。
  3. 用户可见或协议可见的文档行为属于 E2E 测试计划。
  4. 导航应暴露最短的有用路径;仍保留深层文件 可搜索并可直接链接。

为本地优先开发而构建。