codex-bot
8bbe78e01e
Verify databases and deploy Aster VM / verify-and-deploy (push) Successful in 13m40s
42 lines
3.1 KiB
Markdown
42 lines
3.1 KiB
Markdown
# 文档索引
|
|
|
|
这里保存与源码一起版本管理的全局说明。当前页面负责找入口；局部文件职责由对应代码目录 README 维护。阅读次序：系统架构 → 运行时主题 → 对应源码目录。运行部署则从 operations 进入。
|
|
|
|
## 按问题查找
|
|
|
|
| 想知道什么 | 权威说明 | 代码入口 |
|
|
| --- | --- | --- |
|
|
| 四个 crate 如何分层，哪些能力已实现 | [架构](architecture/README.md) | [crates](../crates/README.md) |
|
|
| EndorObject、对象头、句柄、默认操作 | [对象模型](runtime/objects.md) | [core/src](../crates/core/src/README.md) |
|
|
| Number、String、Dict、Cell、Function、异常数据 | [基本对象](runtime/builtins.md) | [core/src](../crates/core/src/README.md) |
|
|
| 操作码、代码验证、局部槽、调用协议 | [字节码 VM](runtime/bytecode.md) | instruction.rs / code.rs / frame.rs / eval.rs；见 [文件表](../crates/core/src/README.md) |
|
|
| VM、对象与执行帧何时创建／释放，循环如何回收 | [生命周期](runtime/lifecycle.md) | heap.rs / eval.rs；见 [文件表](../crates/core/src/README.md) |
|
|
| LC_CTYPE、UTF-8、环境变量和执行限额 | [配置](operations/configuration.md) | [core](../crates/core/README.md)、[storage](../crates/storage/README.md)、[server](../crates/server/README.md) |
|
|
| CLI／HTTP 怎么运行，存储保存什么 | [运行](operations/README.md) | [cli](../crates/cli/README.md)、[server](../crates/server/README.md) |
|
|
| Docker、PostgreSQL、ces-control、回退与数据目录 | [部署](operations/deployment.md) | [scripts](../scripts/README.md)、[工作流](../.gitea/workflows/README.md) |
|
|
| 检查覆盖什么，结果如何确认 | [验证](operations/validation.md) | [core/tests](../crates/core/tests/README.md)、[storage/tests](../crates/storage/tests/README.md) |
|
|
| 改代码后文档写在哪里、怎样避免失效 | [维护规则](contributing/README.md) | 各目录 README 与本索引 |
|
|
|
|
## 多层目录
|
|
|
|
| 目录 | 负责的内容 |
|
|
| --- | --- |
|
|
| [architecture](architecture/README.md) | 系统边界、依赖方向和跨组件约束 |
|
|
| [runtime](runtime/README.md) | 对象、基本载荷、字节码和生命周期 |
|
|
| [operations](operations/README.md) | 运行、配置、部署和验证 |
|
|
| [contributing](contributing/README.md) | 开发定位方法与随代码更新文档的规则 |
|
|
|
|
原 outputs/bytecode-vm.md 与 endor-builtins-design.md 已核对并融合到 runtime 下的对应主题；不再在 outputs 维护独立版本。原 docs 平铺文档已迁入这些主题。过时启动模型、旧测试通过数量和机器资源快照已移除；历史内容需要时查 Git 历史，不混入当前行为说明。
|
|
|
|
## 仓库内查询
|
|
|
|
在仓库根目录使用静态文本检索：
|
|
|
|
```sh
|
|
rg -n 'LC_CTYPE|UTF-8|DATABASE_URL' docs crates --glob '*.md'
|
|
rg -n 'EndorFrame|ReturnValue|collect_cycles' crates/core/src
|
|
rg --files -g README.md -g '!work/**' -g '!outputs/**' -g '!target/**'
|
|
```
|
|
|
|
没有额外的文档服务器或搜索依赖。新增主题时更新此表；新增受版本管理的目录时增加 README，并从父目录 README 链接过去。
|