docs(i18n): proofread active Chinese documentation

This commit is contained in:
xjt
2026-08-04 17:36:14 +08:00
parent 11bad56fc3
commit 2db712eec7
976 changed files with 3180 additions and 3105 deletions

View File

@@ -22,11 +22,11 @@ ctx.emit('event-name', payload)
## 事件模式
Cordis 提供多种事件触发模式,适用于不同场景
Cordis 提供多种事件模式,适用于不同的交互契约
### emit — 广播
所有监听器同步执行,不关心返回值:
所有监听器同步执行,返回值会被忽略
```ts ignore-check
// Emit
@@ -40,7 +40,7 @@ ctx.on('my-plugin/ready', ({ id }) => {
### bail — 短路
依次调用监听器,第一个返回非 `undefined` 值的结果作为最终
依次调用监听器,第一个非 `undefined` 的返回值将作为最终结果
```ts ignore-check
// Dispatch
@@ -61,7 +61,7 @@ ctx.on('some-check', (input) => {
await ctx.serial('setup-phase', context)
```
### waterfall — 管道
### waterfall(瀑布式事件)— 流水线
每个监听器可以包装下游返回值,形成处理链。**必须调用 `next()` 传递给下游**,不调用即为否决:
@@ -77,10 +77,10 @@ ctx.on('my-plugin/transform', async (_input, next) => {
```
::: warning
Waterfall 监听器**必须调用 `next()`**。不调用 `next` 等于否决整个管道,这是故意为之的设计——用于实现拦截/网关逻辑。
waterfall 监听器**必须调用 `next()`**。不调用 `next` 等于否决整个流水线,这是故意为之的设计——用于实现拦截/网关逻辑。
:::
## Typed Events
## 类型安全的事件
Harness 使用 TypeScript 声明合并来为事件提供类型安全:
@@ -101,11 +101,11 @@ declare module 'cordis' {
## Cordis 事件与会话记录
Harness 的 Cordis 事件遵循 `namespace/action` 命名,例如 `agent/step`、`agent/request`、`agent/request-error`、`tools/result` 和 `session/event`。完整签名与触发模式见[Events 目录](../../../cordis-catalog/events.md)。
Harness 的 Cordis 事件遵循 `namespace/action` 命名,例如 `agent/step`、`agent/request`、`agent/request-error`、`tools/result` 和 `session/event`。生成的[事件目录](../../../cordis-catalog/events.md)记录了完整签名与触发模式
`turn/*`、`step/*`、`tool/call`、`tool/result` 和 `compact/*` 是持久化的会话事件类型,不是同名 Cordis 事件。需要观察它们时,监听 `session/event` 并检查 `event.type`。
## 事件也是效果
## 事件监听器也是效果
通过 `ctx.on()` 注册的监听器会在插件卸载时自动移除:
@@ -116,9 +116,9 @@ export function apply(ctx: Context) {
}
```
## 实战示例:日志插件
## 示例:日志插件
一个记录所有 tool 调用的简单插件
这个插件记录工具调用和工具结果
```ts
import type { Context } from 'cordis'
@@ -139,5 +139,5 @@ export function apply(ctx: Context) {
## 下一步
- [能力三件套](../practice/) — 事件在 capability seam 中的角色
- [LLM 适配器](../practice/llm-adapter.md) — 实现一个完整的 LLM 后端
- [能力分层](../practice/) — 了解能力接口中的事件
- [LLM(大语言模型)适配器](../practice/llm-adapter.md) — 实现一个完整的 LLM 后端