功能和 AI 集成

​

搜索

​

内置搜索

搜索功能已集成到每个页面的标题栏中：

• 语义搜索 — 理解上下文和含义，而不仅仅是精确的关键词匹配
• 即时结果 — 输入时查看建议和结果
• 页面预览 — 点击前快速预览匹配内容
• 关键词增强 — 页面包含元数据关键词以提高可发现性

​

如何使用搜索

1. 点击页眉中的搜索栏（或按/ 以聚焦它）
2. 输入您的问题或搜索词
3. 浏览结果或选择一个建议
4. 对于对话式查询，请使用 AI 助手选项

​

AI 助手

AI助手集成了搜索功能，并能为您提供智能答案。

​

功能

• 回答问题 — 了解有关 Livepeer 协议、产品和生态系统的问题
• 解释概念 — 通过清晰的解释理解复杂主题
• 查找文档 — 发现相关页面和指南
• 代码指导 — 获取代码示例和实现的帮助

​

如何使用 AI 助手

1. 点击页眉中的搜索栏
2. 用自然语言输入您的问题
3. 查看AI生成的回复
4. 点击相关文档的链接以了解更多信息

​

AI 集成

该文档设计为 AI 友好，并与以下内容集成：

• OpenAI — 对于 AI 助手功能
• Claude — 替代 AI 集成支持
• 其他 LLM — 结构化内容，优化用于 AI 解析

​

AI 优化内容

文档的结构旨在易于被AI系统使用：

• 语义标题 — 清晰、描述性的标题，传达含义
• 结构化元数据 — 更好的人工智能理解的综合元数据
• 机器可读引用 — OpenAPI 规范、JSON 示例和结构化数据
• 清晰的解释 — 针对 LLM 解析优化的简明摘要和解释

​

导航功能

​

标签导航

内容根据用户角色组织到标签中：

• 首页 — 概述和入门
• 关于 — 核心概念和协议细节
• 社区 — 社区资源
• 开发者 — 在 Livepeer 上构建
• 网关 — 网关操作
• 协调者 — 协调者设置和管理
• 委托人 — 存款和委托
• 资源 — 参考中心

​

侧边栏导航

• 可折叠 — 通过折叠侧边栏最大化阅读空间
• 分层 — 组织好的组和部分
• 锚点 — 快速访问快速入门和参考中心
• 面包屑 — 始终了解您的位置

​

版本切换

访问当前（v2）和旧版（v1）文档：

• 版本选择器 — 在标题中切换版本
• 保留内容 — 所有 v1 内容都保留以供参考
• 明确的指示 — 当前版本有明确标记

​

交互元素

​

标签页

在页面内，标签页按上下文分隔内容：

• 不同的操作系统 (Linux, macOS, Windows)
• 不同的工作流程 (AI 与视频, 链上与链下)
• 不同的用户类型或使用场景

​

视图

自定义视图根据以下内容显示不同的内容:

• 操作系统
• 用户路径或旅程
• 配置类型

​

步骤

顺序指令使用 Steps 组件进行：

• 安装指南
• 配置流程
• 设置工作流

​

卡片组

视觉分组为：

• 带有关键入口点的门户页面
• 资源中心
• 相关内容集合

​

强调

重要信息以以下方式突出显示：

• 信息 — 一般信息和技巧
• 提示 — 有用的建议
• 警告 — 重要注意事项
• 危险 — 严重警告
• 注意 — 额外的上下文

​

反馈机制

​

页面反馈

对任何页面提供反馈:

• 点赞/踩 — 快速反馈页面是否有帮助
• 评论 — 提供具体的反馈或建议
• 问题报告 — 报告错误或过时的信息

​

自动化

文档包含多个自动化流程，以确保准确性并减少手动工作量：

​

数据获取

• 外部文档 — 从 GitHub 自动获取并嵌入规范
• API 文档 — 从 OpenAPI 规范生成 API 文档
• 动态数据 — 获取并显示 GitHub 发布、论坛帖子、博客文章
• 代码信息 — 自动更新版本号和代码示例

​

内容生成

• SEO 元数据 — 为所有页面自动生成 SEO 标签
• API 参考 — 从 OpenAPI 规范生成 API 文档
• 组件示例 — 维护最新组件示例

​

未来自动化

计划中的自动化包括：

• 语言翻译 — 自动翻译成多种语言
• AI 提示页面 — 从提示生成快速入门指南
• 反馈循环 — 与 Discord 和 GitHub 的集成以获取社区反馈

​

文档结构功能

​

自动页面索引生成

该存储库包含一个内部文档功能，可保持v2/pages 索引文件与当前文件夹和 Markdown 文件结构同步。 它生成的内容：

• v2/pages/<top-level-section>/index.mdx 对于每个直接子文件夹v2/pages/
• v2/pages/index.mdx 作为根聚合索引

格式规则:

• 根级 markdown 链接在每个顶级文件夹索引的顶部首先出现。
• 文件夹和子文件夹名称作为标题显示。
• 链接以 markdown 链接列表格式呈现 (- [Title](/v2/cn/home/mission-control))
• 当页面在 docs.json 导航: - [⚠️ Title](/v2/cn/home/mission-control).

验证和清理规则:

• docs.json 被视为警告标记的只读路由白名单。
• normalization 之后匹配是严格的（删除 “.md/.mdx，删除末尾的 “/index，修剪末尾的 “/。
• 嵌套的 index.mdx / index.md 在顶层部分下的文件会自动被删除 --write 模式。
• 在验证模式下（无 --write），嵌套索引会导致失败，直到被删除。

自动化行为:

• 在预提交时运行，当暂存文件包含v2/pages 更改： node tools/scripts/generate-pages-index.js --staged --write --stage
• 支持手动验证/重建:
  • node tools/scripts/generate-pages-index.js
  • node tools/scripts/generate-pages-index.js --write --rebuild-indexes

​

可访问性

该文档的设计考虑了可访问性:

• 键盘导航 — 完全键盘支持
• 屏幕阅读器支持 — 语义化 HTML 和 ARIA 标签
• 高对比度 — 在浅色和深色主题中均可读
• 响应式设计 — 适用于所有设备尺寸

​

可下载的文档

文档的结构旨在:

• AI 友好 — 优化以供 AI 解析和集成
• 可机读 — 用于程序访问的结构化格式
• 可导出 — 内容以适合AI训练和集成的格式提供

​

下一步

• 学习如何 使用 文档 有效地
• 发现如何 贡献并提供反馈
• 探索 组件库 用于开发者