文档首页/文档中心维护

文档中心维护

公开入口 /docs,控制台右上角提供同站链接。支持 /ui/docs 别名及文章深链接,未知文章返回 404。

目录结构

  • frontend/src/app/docs/[[...slug]]/page.tsx:文章路由。
  • frontend/src/components/docs/catalog.ts:四分类目录、搜索与基础示例。
  • frontend/src/components/docs/expanded.ts:补充文章目录。
  • frontend/src/components/docs/apiSpecs.ts:已实现推理接口的参数与嵌套响应结构。
  • frontend/src/components/docs/DocsCenter.tsx:搜索、阅读、参数和响应表、示例复制。
  • frontend/src/i18n/messages/docs*.ts:中文与英文正文、界面及字段解释。
  • docs/api/en/.md、docs/api/zh-CN/.md:每个 API 的独立双语正文,控制台和官网共同读取。
  • frontend/src/components/docs/DocumentationMarkdown.tsx:代码语言标签、语法高亮、复制、换行与真实章节目录。

API Markdown 统一包含接口概述、接口与认证、请求参数、请求示例、成功响应、错误与排查、能力与计费边界。编辑 Markdown 即同步两端正文;目录与可运行契约保留在 catalog.ts 与 apiSpecs.ts。代码围栏标明 shell、json、http 等语言。控制台根据调试台网关根地址填充 curl,复制获取可执行原文;静态官网使用 XHUB_BASE_URL 环境变量供实际部署配置。

新增文章同时维护双语内容。示例命令、提示词与配置使用英文和占位凭据。接口核对 gateway 处理器与 provider 传输登记,禁止仅根据 catalog 路径表宣称功能可用;不提供尚未实现的批处理、文件存储等调用教程。

四大分类切换时,左侧目录、搜索和前后篇导航只显示当前分类。分类内部使用 catalog.ts 的 docSection 归组,并维护全部语言的 sections 标签。

网关根地址使用与调试台相同的 getProxyBaseUrl 来源,工具配置不附加 /v1,浏览器展示时替换占位主机,curl 提供实际根地址环境变量。保留反向代理前缀;接口完整路径根据已登记协议保留必要版本段,不对所有路径全局删除 v1。

API 文档展示请求字段、嵌套响应字段、状态示意与可复制示例。示意响应不是固定供应商返回保证。第三方工具步骤是配置指南,外部版本、账号和实服务兼容性需单独验收。

计费文档核对 development/pricing.md;缓存输入为输入子集,usd 是每基础单位价,预算不是预占,日志与报表不等同完整供应商账单。

测试与截图报告保存于 .e2e/docs-center/。E2E 执行文档 curl 到隔离网关与测试上游,核对模型列表、无效密钥和入账费用,并清理专用模型、密钥与临时文件。

操作帮助与官网同步

产品分类增加安装配置、供应商部署、组织权限、调试集成、路由、护栏、费用日志及故障排查八篇中英帮助。help.ts 定义路径,docs-help.*.ts 提供正文。

官网构建器 website/src/console-docs.mjs 从同一目录、翻译和接口结构生成静态文章及全文搜索,/xhub/docs/ 进入同步中心。构建触发器覆盖控制台文档源变动;既有仓库安装、管理与开发参考保留。静态官网配置使用 localhost:4000 作为本地安装示例,需替换为实际调试台地址。实例文档在线运行使用当前网关,官网静态阅读不接收密钥、不执行请求。

GET /models 无显式凭据时公开已启用模型名及标准元信息,不包含供应商凭据、部署地址或管理字段;显式密钥仍过滤权限,错误密钥返回 401。GET /v1/models 要求鉴权;推理始终需要凭据。

接口方法、网关根地址与路径在文章顶部的接口栏展示;点击“在线运行”打开模态弹窗,打开本身不发送请求。关闭按钮或 Escape 关闭弹窗,清空内存凭据并取消浏览器等待,重新打开从默认英文示例开始。弹窗限制高度并在内部滚动以支持手机。文档运行器仅主动点击发送请求;支持 JSON、multipart、GET 任务查询与响应显示,不重试,60 秒超时,离开文章清除密钥并取消浏览器等待。取消不保证上游取消任务或免除已产生费用。二进制响应显示类型与大小;当前不提供下载播放器。浏览器跨域需由实际部署配置允许。

输入关键词搜索全文,例如:预算、路由、Docker