docs(i18n): proofread bilingual README corpus

This commit is contained in:
j-xiang
2026-09-10 00:21:32 +08:00
parent 08f646da36
commit 8e8fb2fc62
744 changed files with 2592 additions and 2631 deletions
@@ -3,4 +3,4 @@
# after editing either side, bring the other along and re-record with:
# pnpm run verify-translation-pairing --write packages/webhook/webhook-github/README.md
README.md: 9c2b20f4abbc183fd5aa78454ce3b2c9266aa79c
README.zh.md: 34d847b76acf4ead271f5005a924df6563aacb9f
README.zh.md: 8dae90aaa7a1d6df6d50e3170f841e986ce6e97d
+14 -14
View File
@@ -9,15 +9,15 @@ kind: "package-reference"
## 概述
`dsh-webhook-github` 会在注入的 `ctx.webServer` 上注册一条精确 HTTP 路由。它限制并验证 GitHub 原始 JSON body,投影提供方无关的交付,调用 `ctx.webhookRuntime.dispatch()`,并在不等待规则或 Session 的情况下返回 `202`。部署需要为通用 webhook runtime 提供经过身份验证的 GitHub 入口时,请使用它。
`dsh-webhook-github` 会在注入的 `ctx.webServer` 上注册一条精确 HTTP 路由。它限制并验证 GitHub 原始 JSON body,投影提供方无关的交付,调用 `ctx.webhookRuntime.dispatch()`,并在不等待规则或会话的情况下返回 `202`。部署需要为通用 webhook 运行时提供经过身份验证的 GitHub 入口时,请使用它。
## 目录
- [配置](#configuration)
- [HTTP 约定](#http-contract)
- [专用监听器组合](#dedicated-listener-composition)
- [Model Experience](#model-experience)
- [Known Limitations and Deferred Work](#known-limitations-and-deferred-work)
- [模型体验](#model-experience)
- [已知限制与延期工作](#known-limitations-and-deferred-work)
- [开发备注](#dev-note)
-----
@@ -47,9 +47,9 @@ kind: "package-reference"
| `405` | 方法不是 `POST`。 |
| `413` | 声明或流式 body 超过 `maxBodyBytes`。 |
| `415` | media type 不是 `application/json`。 |
| `503` | 凭据或 webhook runtime 不可用。 |
| `503` | 凭据或 webhook 运行时不可用。 |
`202` 不表示任何规则已经匹配,也不表示已创建 Session。GitHub 事件特定字段的验证属于各规则;适配器只保证通过身份验证的通用 JSON。
`202` 不表示任何规则已经匹配,也不表示已创建会话。GitHub 事件特定字段的验证属于各规则;适配器只保证通过身份验证的通用 JSON。
<a id="dedicated-listener-composition"></a>
## 专用监听器组合
@@ -57,22 +57,22 @@ kind: "package-reference"
普通 Web profile 已经拥有 `ctx.webServer`。把另一个 `dsh-host-webserver` 和此适配器挂载到仅隔离 `webServer` 的 group 内;适配器仍会继承凭据与 `webhookRuntime`。[GitHub 评审指南](../../../docs/user/guide/github-review.zh.md)在 TLS 反向代理后使用 `127.0.0.1:3081/github`,而 UI 继续位于端口 3080。
<a id="model-experience"></a>
## Model Experience
## 模型体验
通过 `dsh-webhook` 间接产生影响:此适配器不贡献提示词或工具 schema;匹配规则拥有 Session 请求与模型可见文本。
通过 `dsh-webhook` 间接产生影响:此适配器不贡献提示词或工具 schema;匹配规则拥有会话请求与模型可见文本。
#### KV Cache effect
#### KV Cache 影响
相互独立。身份验证与 HTTP 分发不触碰模型请求;任何新 Session 前缀都属于消费它的规则与 runtime
相互独立。身份验证与 HTTP 分发不触碰模型请求;任何新会话前缀都属于消费它的规则与运行时
## Known Limitations and Deferred Work
## 已知限制与延期工作
<a id="known-limitations-and-deferred-work"></a>
- **无 TLS**注入的开发 WebServer 通常只监听 loopback,并位于 TLS 反向代理或 tunnel 后。
- **仅通用 payload 验证**规则负责验证自己消费的 GitHub 事件字段。
- **不向提供方确认下游工作**`202` 先于任意规则调用与 Session 创建。
- **不支持表单编码**GitHub 必须发送 `application/json``application/x-www-form-urlencoded` 会被拒绝。
- **无 TLS**注入的开发 WebServer 通常只监听 loopback,并位于 TLS 反向代理或 tunnel 后。
- **仅通用 payload 验证**规则负责验证自己消费的 GitHub 事件字段。
- **不向提供方确认下游工作**`202` 先于任意规则调用与会话创建。
- **不支持表单编码**GitHub 必须发送 `application/json``application/x-www-form-urlencoded` 会被拒绝。
<a id="dev-note"></a>