基于 arrow-simple 源码更新 astra-faber-docs 文档站点。更新主页产品介绍(Vera、Arca、Anima、Cosmo),维护 SDK 使用文档。Use when the user asks to update documentation, sync docs with code, or generate product pages.
文档项目路径:/Users/curtis/workspace/astra-faber/astra-faber-docs
源码项目路径:/Users/curtis/workspace/github/arrow-simple
文档框架:VitePress 1.6.3,语言 zh-CN,品牌色 #7c3aed(紫色系)。
| 产品 | 定位 | 状态 | 面向用户描述 |
|---|---|---|---|
| Vera | 物模型平台 | 已发布 | 设备建模与管理、属性同步、设备孪生 |
| Arca | 文件服务 | 已发布 | 文件上传与管理、MCAP 录制、日志存储 |
| Anima | 数字孪生引擎 | 建设中 | 3D 可视化、实时数字孪生、场景回放 |
| Cosmo | 仿真平台 | 建设中 | 物理仿真、场景模拟、自动化测试 |
重要原则:
从源码项目读取以下内容,了解最新变化:
# 产品架构(了解产品线和定位)
docs/PLATFORM_ARCHITECTURE.md
# astra-faber SDK 源码(统一 SDK,按 feature 拆分 vera / arca 模块)
sdks/astra-faber/
├── Cargo.toml → features: vera, arca(默认全部启用)
├── vera/ → ThingsClient, sync, schema, conflict
└── arca/ → FileClient, McapRecorder, Uploader, RotatePolicy
# Vera API Proto(了解接口定义)
crates/vera-api/proto/
# Arca API Proto
crates/arca-api/proto/
# 物模型定义
crates/vera-things/ → ThingModel, Slot, Property
index.md # 主页
.vitepress/config.ts # 导航和侧边栏配置
sdk/ # SDK 文档目录(按 vera / arca 模块组织)
主页结构应包含:
Vera(物模型平台):
Arca(文件服务):
Anima(数字孪生引擎)— 即将推出:
Cosmo(仿真平台)— 即将推出:
在 features 之前或之后插入产品卡片区域,使用自定义 HTML + CSS,与现有 custom.css 风格一致(紫色渐变、圆角卡片、hover 动画)。
SDK 统一为 astra-faber,按 Vera 和 Arca 两个模块拆分文档。SDK 文档是核心内容,可以详细。
sdk/
├── index.md # astra-faber SDK 总览(安装、feature 配置、架构简介)
├── vera/
│ ├── client.md # Vera Client(数据读写、Schema、表/设备操作)
│ └── things.md # Vera Things(设备孪生、属性同步、离线队列)
└── arca/
├── file.md # Arca File(文件上传、预签名 URL)
└── recorder.md # Arca Recorder(MCAP 录制、自动轮转、上传)
介绍 astra-faber SDK 整体:
Cargo.toml 依赖配置,说明 feature flags# 全部功能(默认)
[dependencies]
astra-faber = { version = "x.x", features = ["vera", "arca"] }
# 仅物模型
astra-faber = { version = "x.x", features = ["vera"] }
# 仅文件服务
astra-faber = { version = "x.x", features = ["arca"] }
# [模块名称]
[一句话描述]
## 快速上手
[最小可运行代码示例]
## 核心 API
### [主要类/结构体]
[API 说明 + 代码示例]
## 进阶用法
[高级功能、配置选项]
## 错误处理
[Error 类型说明]
vera/client.md — 数据读写客户端:
vera/things.md — 设备孪生(Things):
arca/file.md — 文件上传:
arca/recorder.md — MCAP 录制:
sdks/astra-faber/Cargo.toml 获取 feature 定义和版本sdks/astra-faber/src/lib.rs 和各模块 mod.rs 获取公开 APIexamples/ 目录获取用法示例更新 .vitepress/config.ts,确保导航和侧边栏包含所有产品和 SDK 页面: