CyberScrubber
|
8b2532a9c1
|
docs: fix documentation deviations from source code (#220)
* docs: 修正 docs/conversation 文档与源码的偏差(multi-turn/streaming/the-loop)
- multi-turn: TranscriptWriter→Project 私有类, 会话路径改用 sanitized-cwd,
补充 StoredCostState.lastDuration 字段, 模型切换改为 setModel(),
QueryEngine 状态补全 loadedNestedMemoryPaths/hasHandledOrphanedPermission,
行号改为符号引用
- streaming: STALL_THRESHOLD_MS 10s→30s, 新增 90s 主动空闲看门狗描述,
非流式降级补充 didFallBackToNonStreaming/executeNonStreamingRequest,
行号改为符号引用
- the-loop: 终止条件 7→11, 继续条件重整为 5 组层级结构,
max_output_tokens 拆分 escalate/recovery 子阶段,
prompt-too-long 拆分 collapse_drain/reactive_compact 子策略,
State 类型修正 autoCompactTracking 为可选, 行号改为符号引用
- 全部: 添加 sourceRef 版本锚定(3ec5675)
* docs: 修正 docs/extensibility 文档与源码的偏差(custom-agents/hooks/skills)
- custom-agents: Verification 模型修正为 inherit, 补充 Plugin Agent 字段限制
(permissionMode/hooks/mcpServers 被安全忽略, isolation 仅 worktree),
加载流程修正为 6 层优先级, 补充 memory snapshot 门控条件
- hooks: 事件数 22→27(补充 Notification), Hook 类型定义位置修正为 3 个文件,
行号改为符号引用, Zod schema 范围修正, 去重键修正为四部分复合键,
registerFrontmatterHooks/clearSessionHooks 区分定义位置和调用位置
- skills: 字段数 17→16, 权限层级 4→5(补充 remote canonical auto-allow),
SAFE_SKILL_PROPERTIES 28→30, skillUsageTracking 路径修正,
行号改为符号引用
- mcp-protocol: 全部验证通过, 无需修改
- 全部: 添加 sourceRef 版本锚定(3ec5675)
* Revert "docs: 修正 docs/extensibility 文档与源码的偏差(custom-agents/hooks/skills)"
* docs: 修正 docs/extensibility 文档与源码的偏差(hooks/skills/mcp-protocol)
hooks:
- 事件数 22→27(补充 Notification 事件)
- Hook 类型定义位置修正为 3 个文件分布
(schemas/hooks.ts / types/hooks.ts / utils/hooks/sessionHooks.ts)
- Zod schema 引用从硬编码行号改为符号引用
- hookSpecificOutput 表从 6 扩展至 15 个事件
(补全 permissionDecisionReason / PostToolUseFailure / SubagentStart 等)
- 去重键从 pluginRoot\0command 修正为四部分复合键
(pluginRoot\0shell\0command\0ifCondition)
- 全部硬编码行号改为符号引用以避免版本漂移
skills:
- parseSkillFrontmatterFields 字段数 17→16
- SAFE_SKILL_PROPERTIES 属性数 28→30
- checkPermissions 层级 4→5
- 第 2 层描述从"官方市场"修正为"远程 canonical"
mcp-protocol:
- 配置层级从"三级"修正为
"enterprise 独占或合并 user/project/local + plugin + claude.ai"
* docs: 修正 system-prompt.mdx 中 Boundary 章节的层级与可读性
- Boundary 插入条件从 ### 降为 blockquote，不再打断三种分块模式的并列结构
- 表格中 Boundary 缓存策略列补充说明其分割作用
- 新增 Boundary 概念释义（blockquote），解释其分割静态区/动态区以实现全局缓存的设计意图
|
2026-04-09 17:53:11 +08:00 |
|