文档数据与 AI

VextJS 同时提供面向读者的文档页面和确定性的构建产物。这样能让搜索、AI 辅助分析和文档质量检查更可靠, 不需要读者信任不透明的 crawler 或 tracker。

公开机器可读资产

资产用途
docs-manifest.json构建生成的页面元数据:canonical URL、locale、摘要、受众、适用面、稳定性、关联页面和 source hash。
capabilities.json已支持的 frontend/runtime 能力和明确 non-goal;必须与对应细节页一起引用。
ai-gold-questions.json要求引用来源的问题集合,防止回答虚构未支持能力。
zh/llms.txt面向语言模型和文档工具的简体中文精选入口;它是索引,不是 crawler 控制文件。
zh/llms-full.txt完整简体中文 URL 与摘要索引:每个公开中文文档页只出现一次。
llms.txt默认英文精选入口,与简体中文内容隔离。
llms-full.txt完整英文 URL 与摘要索引:每个公开英文文档页只出现一次。
docs-events.schema.json可选的隐私保护事件合同;VextJS 没有启用 collector。
docs-dashboard-definition.json供未来自行选择合规 collector 的站点所有者使用的指标定义和采集边界。

机器资产在文档构建完成后生成,不含 build timestamp,因此相同 source 会生成相同的 metadata 和 hash。

语言与完整性合同

四个 llms*.txt 文件都是确定性生成的 UTF-8 Markdown,并以 plain text 提供。根目录文件只包含英文; /zh/ 下的文件只包含简体中文。llms.txt 刻意保持精选,帮助模型不用载入整个站点就能找到主要阅读路径; llms-full.txt 则是当前 locale 的穷尽索引,每个页面都有唯一 canonical URL 和从源文档提取的摘要。 docs-manifest.json 仍是权威双语总清单,并记录每条 entry 的 locale 与 source hash;构建会验证每个 locale 的精确覆盖。

这里的 “full” 表示完整索引,不是复制所有页面正文。具备网页访问能力的 AI 会继续读取 canonical URL;离线工具 可以先用 manifest 和索引精确选择所需页面。这样既保持 1:1 的构建期覆盖证明,也避免把全部双语源文档一次性 塞入模型上下文。

AI 回答应如何使用文档

  1. 先在 docs-manifest.json 中定位相关条目,并引用其中的 canonical URL。
  2. 在宣称某个 frontend 能力已支持或被排除前,检查 capabilities.json
  3. 对 RSC、Server Functions、Server Actions、PPR 和 bundler 假设,不要从 React、SSR、Suspense 或 Streaming SSR 推断,必须阅读前端边界与路线图
  4. ai-gold-questions.json 做基于文档的回答回归集;没有来源的“看起来合理”答案不应被接受。

度量是可选且隐私优先的

VextJS 不会为这个文档站内置 tracker、analytics SDK、collector endpoint、cookie 或 identity graph。 事件 schema 只允许记录页面、locale、事件类型、referrer class、可选的搜索长度和 CTA 类型;明确排除了原始 搜索文本、URL query 值、凭据、页面内容和用户身份。

站点所有者如需后续接入 collector,必须先选择 provider、legal basis、retention、consent 行为和安全评审。 这些 JSON 文件只定义实现可以度量什么,不代表可以直接采集数据,也不能单独用于推断收入或转化。

需要反馈文档缺口时,请发起 GitHub Discussion