Skip to content

文档说明

目标

这套文档站只做一件事:把 robin-sdk-next 当前正式对外的 API 结构、字段、调用入口和发布支持状态,用可浏览的方式展示出来。

生成原则

  • 不手工维护 API 目录树
  • 不手工维护每个方法页的基础骨架
  • 以 SDK 当前真实 public API 和 release 产物为准
  • 允许后续按方法叠加少量 override,但 override 不是页面存在的前提

目录结构

  • api/:自动生成的 API 页面
  • .generated/:自动生成的数据和 VitePress 侧栏配置
  • scripts/:同步脚本
  • .vitepress/:VitePress 配置与主题定制

更新方式

当以下目录发生变化时,应重新同步文档:

  • src/public_api/
  • public-api/
  • release/phase0/
  • proto/

执行命令:

bash
npm run docs:sync