Initialize local Tabularium documentation monorepo
This commit is contained in:
@@ -0,0 +1,30 @@
|
||||
# 开始使用
|
||||
|
||||
Tabularium 是 Endor 的本地文档工作台。文档与图形源码都保存在同一个仓库。
|
||||
|
||||
## 启动
|
||||
|
||||
在仓库根目录运行:
|
||||
|
||||
```sh
|
||||
pnpm install --frozen-lockfile
|
||||
uv sync --project tools/figures --locked
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
浏览器打开 http://127.0.0.1:3000 。
|
||||
|
||||
## 添加文档
|
||||
|
||||
在 `content/docs` 下添加 Markdown 文件,例如 `04-runtime.md`。文件名使用小写字母、数字和连字符;第一个一级标题是导航标题。该文件对应 `/docs/04-runtime`。
|
||||
|
||||
开发模式下刷新页面读取修改;本地生产预览需要重新构建。
|
||||
|
||||
## 检查
|
||||
|
||||
```sh
|
||||
pnpm check
|
||||
pnpm start
|
||||
```
|
||||
|
||||
所有命令都在本地运行。Git 远程只负责源码同步,不承担构建或部署。
|
||||
@@ -0,0 +1,25 @@
|
||||
# 节点与对象挂载(草案)
|
||||
|
||||
> 状态:讨论草案。以下记录当前设计方向,不代表协议已经实现或接口已经定稿。
|
||||
|
||||
## 设计方向
|
||||
|
||||
每一个 Aster VM 是一个节点。实例之间可以通过统一接入协议挂载对象。
|
||||
|
||||
接入对象来源包含 Endor 官方配件,例如 Tessera GUI,以及通过 Endor Python、C、Go、JavaScript 等 SDK 接入的第三方程序。这两类接入采用同一套协议。
|
||||
|
||||
## 待确认的术语
|
||||
|
||||
| 概念 | 当前提议 | 状态 |
|
||||
| --- | --- | --- |
|
||||
| Node | 一个 Aster VM | 用户提出的模型 |
|
||||
| Endpoint | 统一协议的连接端点 | 术语提议 |
|
||||
| Export Root | 对外导出的顶级对象入口 | 术语提议 |
|
||||
| Tessera 顶级对象 | 协议层称 root,挂载名可为 tessera | 尚未确定 |
|
||||
|
||||
## 后续设计问题
|
||||
|
||||
- 对象的导出、身份、远程引用与生命周期。
|
||||
- 方法调用、属性访问和事件传播的语义。
|
||||
- 授权、断连、错误与重新连接。
|
||||
- 官方配件和不同语言 SDK 的共同协议边界。
|
||||
@@ -0,0 +1,17 @@
|
||||
# 图形与脚本
|
||||
|
||||
Python 绘图项目位于 `tools/figures`,使用 drawsvg 输出可编辑 SVG。脚本与输出都保留在 Git 中。
|
||||
|
||||
```sh
|
||||
pnpm figures
|
||||
```
|
||||
|
||||
下图是制图工作流的最小示例,用于验证从 Python 源码到文档图片的完整链路。
|
||||
|
||||

|
||||
|
||||
## 扩展方式
|
||||
|
||||
在 `tools/figures/src/endor_figures` 下保留各张图的生成逻辑,并在 CLI 中调用。输出目录通过源码位置计算,不依赖运行命令时所在的目录。
|
||||
|
||||
图形应使用本地字体与资源,并明确标注草案状态。未来可按具体需求加入自动布局、PNG 转换或 TypeScript SVG 工具。
|
||||
Reference in New Issue
Block a user