Skip to content

Commit f90fbe1

Browse files
author
developerworks
committed
Update docs
1 parent 287c3a4 commit f90fbe1

3 files changed

Lines changed: 2 additions & 23 deletions

File tree

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Package name: `rust-tokio-supervisor`. Library crate name: `rust_supervisor`.
3737
- Emit structured logs, tracing spans, metrics, audit events, event journal entries, and `RunSummary` diagnostics.
3838
- Enable target-side dashboard IPC through the optional `ipc` configuration section. The target process owns only local Unix domain socket IPC, snapshot generation, event conversion, command mapping, and shared JSON contracts.
3939

40-
## Dashboard Boundary
40+
## Dashboard
4141

4242
The supervisor dashboard feature uses three directories.
4343

@@ -49,10 +49,6 @@ The target process does not expose IPC to the network. It opens a local Unix dom
4949

5050
![rust-supervisor dashboard screenshot](docs/screenshot.png)
5151

52-
## No Compatibility
53-
54-
No Compatibility: this crate is a new project with no legacy API aliases. Consumers should import public types from their owning module paths, for example `rust_supervisor::runtime::supervisor::Supervisor`.
55-
5652
## Configuration Schema
5753

5854
`SupervisorConfig` is the public root configuration struct. It supports `confique::Config`, `schemars::JsonSchema`, `serde::Serialize`, and `serde::Deserialize`, so users can reuse one model for YAML loading, template generation, and schema generation.

README.zh.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
- 发出 structured log(结构化日志), tracing span(追踪跨度), metrics(指标), audit event(审计事件), event journal entry(事件日志条目) 和 `RunSummary`(运行摘要) diagnostics(诊断信息).
3636
- 通过可选 `ipc` 配置启用 target-side dashboard IPC(目标侧看板进程间通信). target process(目标进程) 只拥有本机 Unix domain socket IPC(Unix 域套接字进程间通信), snapshot(快照) 生成, event conversion(事件转换), command mapping(命令映射) 和 shared JSON contract(共享 JSON 契约).
3737

38-
## Dashboard Boundary(看板边界)
38+
## 看板
3939

4040
dashboard(看板) 功能固定拆成三个目录.
4141

@@ -47,10 +47,6 @@ target process(目标进程) 不把 IPC(进程间通信) 暴露到外网. 它只
4747

4848
![rust-supervisor dashboard(看板) screenshot(截图)](docs/screenshot.png)
4949

50-
## No Compatibility(不兼容承诺)
51-
52-
No Compatibility(不兼容承诺): 本 crate(包) 是新项目, 不提供 legacy API alias(旧接口别名). 使用者应该从类型所属模块路径导入 public type(公开类型), 例如 `rust_supervisor::runtime::supervisor::Supervisor`.
53-
5450
## Configuration Schema(配置结构模式)
5551

5652
`rust_supervisor::config::configurable::SupervisorConfig` 是 crate user(crate 使用者) 可以复用的配置入口. 它用于 YAML(数据序列化格式) 加载, template generation(模板生成) 和 schema generation(结构模式生成). 使用者不需要为 template(模板) 或 schema(结构模式) 维护第二套模型.

specs/001-create-supervisor-core/contracts/public-api.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,6 @@ src/<module>/
4141

4242
所有内部导入必须使用 `crate::` absolute path(绝对路径).所有外部依赖导入必须使用 external crate name(外部软件包名) absolute path(绝对路径).源码不得使用 `super::` relative path(相对路径).
4343

44-
## No Compatibility Method Contract(禁止兼容方法契约)
45-
46-
本项目是全新开发项目,没有历史包袱.公开 API(接口),示例和文档不得包含下面内容:
47-
48-
- old API alias(旧接口别名).
49-
- migration layer(迁移层).
50-
- historical behavior flag(历史行为保留开关).
51-
- deprecated facade(废弃门面).
52-
- compatibility wrapper(兼容包装函数).
53-
- third-party API shape clone(第三方接口形状复制).
54-
55-
参考 crate(库) 只能提供概念输入.任何对外名称都必须来自本项目自己的模型.
56-
5744
## Naming Contract(命名契约)
5845

5946
代码命名必须使用下面名称:

0 commit comments

Comments
 (0)