关于本文档
- 框架:Starlight 0.42(Astro 7),静态输出;搜索用 Pagefind(支持中文分词)。
- 语言:中文为主(根路径),英文在
/en/,右上角“中/EN”切换。 - 主题:默认深色,可切换浅色;配色沿用 entelechy.run 宣传站的品牌色。
- 代码高亮:Expressive Code + 为
.ent/.esn与.replay编写的 TextMate 语法;每个代码块都有复制按钮。 - 版本:文档对应
0.0.2-rc.3(main分支,生成时的提交)。左上角的版本选择器目前只是占位。
| 部分 | 来源 | 方式 |
|---|---|---|
| 关于、入门、手册 | README.md、HANDOFF.md、docs/*.md、examples/、bridges/ |
手写,每页页脚列出引用的源文件 |
| 教程中的命令输出 | 在 Linux x86_64 上实际运行 entelechy 0.0.2-rc.3 |
原样粘贴(长行截断处标注 ...) |
| 类参考 · 类型/内置函数/能力/语言/协议/命令 | entelechy help --json、entelechy 用法文本、protocol/src/wire.rs |
scripts/gen_reference.py 生成 |
| 类参考 · 包 | 对每个包运行 entelechy serve 并调用 kernels/kernel,解析源码 |
scripts/extract_packages.py |
| 类参考 · Crate | cargo rustdoc --output-format json(nightly) |
scripts/extract_rustdoc.py |
| 示例画廊 | examples/* 与仓库 docs/media |
scripts/gen_examples.py |
已验证与未验证
Section titled “已验证与未验证”在本机实际运行过: cargo build --release -p entelechy、new、check、run(含 --watch、--profile)、replay、graph、trace、serve(stdin)、version、help、C ABI 示例 bridges/c/hello.c,以及教程中的每段 .ent/.esn/.replay。
未在本机验证(按仓库文档描述):
--backend gpu与best:本机没有 GPU(gpu unavailable)。entelechy-player窗口、声音、手柄:需要显示与音频系统库,本机未运行;Player 的 crate 也没有生成 rustdoc(构建依赖 libudev)。- WebAssembly(WASI 与浏览器)构建、Blender/Godot/Web 桥接。
- Windows 与 macOS 上的行为(
HANDOFF.md中每轮验证的是 macOS Apple M4)。
- 自动生成的参考页中,详细描述保留源码中的英文原文,只附中文简述。
xtask与entelechy-player没有 crate API 页面。- 源码链接指向私有仓库
Fynn-3D/entelechy,没有访问权限时打不开。 - 版本选择器是占位,目前只有一个版本。
ARCHITECTURE-PLAN.md、CORE-ARCHITECTURE.md等架构“圣经”没有转写,只在架构中概述。
cd /workspace/entelechy-docspython3 scripts/extract_packages.py # 需要已构建的 entelechypython3 scripts/extract_rustdoc.py # 需要 nightly rustdoc JSONpython3 scripts/gen_reference.pypython3 scripts/gen_examples.pynpm run build # 输出到 dist/
