Skip to content

docs(cases): PR 审查室 cases doc ZH + EN (refs #25)#42

Merged
s2agi merged 1 commit into
mainfrom
feat/issue-25-cases-doc
May 13, 2026
Merged

docs(cases): PR 审查室 cases doc ZH + EN (refs #25)#42
s2agi merged 1 commit into
mainfrom
feat/issue-25-cases-doc

Conversation

@s2agi
Copy link
Copy Markdown
Contributor

@s2agi s2agi commented May 13, 2026

Author & Helpers

Author (Primary): 通信demo马

Helpers:

  • 通信工程马: cli 实施 reference (PR #41 / c1aaf2b)
  • 通信龙: Lead review (proposal final approval + cases doc 绿灯 A 选项)

Tier review gate: 通信龙


Summary

新 cases 页面 docs-site/docs/cases/pr-review-room.md ZH + EN,跟 PR #41 (cli 实施 c1aaf2b) 配对的用户文档。完成 issue #25 提案 → 实施 → 文档 三步闭环。

Refs #25

改动 (5 files, +636 / -2)

文件 改动
docs-site/docs/cases/pr-review-room.md 新增 312 行 ZH cases doc
docs-site/docs/en/cases/pr-review-room.md 新增 314 行 EN mirror
docs-site/docs/cases/index.md 表格加 PR 审查室 entry;把"代码审查"从已下线段挪到恢复上线说明
docs-site/docs/en/cases/index.md 同上 EN mirror
docs-site/docs/.vitepress/config.ts 侧栏 ZH + EN 各加 PR 审查室入口(debate 之后)

内容来源 (per 通信龙 review 绿灯 A — 不跑真 LLM)

为什么不跑真 LLM 拿真输出(discussion task_id 03731b2d):

  • 本地无 MINIMAX_KEY~/.env.local / .env* 都没有)
  • #30 mock LLM protocol 还未实施,无 stable stub
  • 跑真 LLM 烧 token + 单次截屏的非确定性输出反而误导用户

cases doc 内容全部 grounded in shipping code:

  • cli.ts:4423-4775 demoPrReviewCommand 的所有 console.log / console.error / 输出 markdown 结构 — verbatim 引用
  • bun run agent-network/bin/cli.ts demo pr-review --help 实拍输出 → 参数表 + 三种 diff 入口
  • 3 个 sample diff (good-pr / typo-pr / cross-file-pr) + expected/assertions.json 结构断言(决议字段正则 + issue 数范围)
  • PR_REVIEW_PROMPTS (cli.ts:4319-4377) 4 个 systemPrompt 的维度列表 → 角色表

Non-determinism disclaimer 标注位置

per 通信龙 review 给的措辞建议,在 "仓库自带的 3 个样例" 段尾 + "输出 markdown 结构" 段尾各放一条:

⚠️ LLM 输出本质 non-deterministic — 本页下面展示的是输出结构和字段(决议 verdict / issue 数 / 必含 sections / 控制台节奏),具体文字 / 顺序 / 风格随 model 状态、prompt 命中度、采样温度变化。

三块重心 ✅

重心 落实位置
1. §UX 反馈完整呈现 "编排时序(6 步)" + "控制台输出节奏" + "Network 隔离" + "进阶用法" 段(基于 cli.ts 实际行为,标注未实施的 +秒数 UX feature 为 follow-up)
2. 故障排查段 "故障排查" 段 — 13 条 error,verbatim from cli.ts 文本 + 精确恢复命令
3. 用户实际跑命令的 expected output 样例 "输出 markdown 结构" + "控制台输出节奏" 段 — 完整结构 + 字段 + 必含 sections,标注 LLM 非确定性 disclaimer

Test plan

  • ZH + EN 两份 cases doc 都新建,结构对应
  • cases/index.md 双语都更新 PR 审查室 entry + 把"代码审查"挪到恢复上线说明
  • vitepress config.ts 双语侧栏各加 PR 审查室入口
  • 所有 GitHub 链接走 clickable markdown link (per feedback_github_clickable_refs)
  • commit msg 含 Author-Agent + Helpers + Tier review gate (per feedback_attribution_traceability_sop)
  • 不嵌 token / 私有 IP / 本机路径 (per feedback_issue_comment_safety)
  • 后续 follow-up #30 mock LLM 或 Vincent 显式提供 key 后跑一次真 demo,补 real-run sample 截图(另 PR)

不在 PR 范围

  • 不动 agent-network/bin/cli.tsPR #41 已 ship)
  • 不动 tests/test28-pr-review-room/*PR #41 已 ship samples + assertions + run.sh)
  • 不嵌 real-run cli session 截屏(per 通信龙 review,等真跑后另 PR 补)

ping 通信龙 final review + merge。

@s2agi s2agi force-pushed the feat/issue-25-cases-doc branch from b3915f5 to fda26e6 Compare May 13, 2026 04:31
新 cases 页 docs-site/docs/cases/pr-review-room.md (312 行) + en/cases/
pr-review-room.md (314 行),配套更新:

- cases/index.md + en/cases/index.md 表格新增 PR 审查室 entry,
  并把"代码审查"从已下线案例段挪到恢复上线说明里
- .vitepress/config.ts 侧栏 ZH + EN 各加 PR 审查室入口(debate 之后)

内容来源(per 通信龙 review 绿灯 A):
- cli.ts demoPrReviewCommand 4423-4775 行的 console.log / console.error
  / 输出 markdown 结构 verbatim 引用
- bun run agent-network/bin/cli.ts demo pr-review --help 实拍输出
- 3 个 sample diff (good-pr / typo-pr / cross-file-pr) + expected/
  assertions.json 结构断言
- PR_REVIEW_PROMPTS 4319-4377 行 4 个 systemPrompt 维度列表

LLM non-determinism disclaimer 顶部明确标注:本页展示输出结构 + 字段,
具体文字 / 顺序 / 风格随 model 状态变化。assertions.json 结构断言
比 verbatim match 更可靠。

未实施代码 + 0 token 烧 + 0 key 泄漏路径。real-run sample 截图 follow-up
等 #30 mock LLM 落地或 Vincent 显式提供 key 时另 PR 补。

Author-Agent: 通信demo马
Helpers: 通信工程马 (cli 实施 reference), 通信龙 (Lead review)

Refs #25
@s2agi s2agi force-pushed the feat/issue-25-cases-doc branch from fda26e6 to a91d009 Compare May 13, 2026 04:33
@s2agi s2agi merged commit 114edba into main May 13, 2026
s2agi pushed a commit that referenced this pull request May 13, 2026
…-room.md ZH+EN L3 'v0.9 内置 demo' 改 'anet CLI 内置 demo + PR #41 merged' + ZH 修 build break — (1) PR #42 (closes #25, 通信demo马 ship) 创建的 cases doc L3 写 'v0.9 内置 demo' 实际是 cli.ts MODEL 现状 (CLI 2.1.x), 'v0.9' 是混淆 of project release vs CLI 版本号; 改 'anet CLI 内置 demo (PR #41 merged 2026-05-13, 预计跟 CLI v2.1.8 ship latest)' 准确化 + 加 PR 链接 (2) ZH 文件 L224 '**❌ 需要 --diff <file> / --ref <ref> / --pr <github-url> 之一**' 三个 unescaped <name> 在 bold 文本 (非 code) 让 Vue parser 误判 HTML tag, 触发 'Element is missing end tag' 阻塞 build; fix: 三处加 backtick code span 包装 ( 等) 让 Vue 跳过 (3) ZH L264/L268/L228 同款 \<alias\> / \<path\> backslash 转义改 &lt;...&gt; HTML entity 更稳 (Vue 不 confuse). EN 文件不需第 2/3 步 (前置 "--diff" 已 backtick OR EN parser tolerant). ZH+EN 同步 L3 改动
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants