docs: add "Which do I need?" section to READMEs (EN+ZH) - #363
docs: add "Which do I need?" section to READMEs (EN+ZH)#363ranxianglei wants to merge 3 commits into
Conversation
Add the cross-repo client-selection table (pi / opencode / omp / everything else) before "## Installation" in both READMEs, matching the section finalized in ranxianglei/billion-context#511 (PR #512) so all three package READMEs stay consistent. Each project links to its own GitHub repo. Pure docs change; no code, state, or config impact. Fixes #362
📦 Built Plugin ArtifactBranch: Option A — Install from npm PR tag (recommended)opencode plugin opencode-acp@pr-363 --globalEach push to this PR publishes a new version under the Option B — Install from GitHubopencode plugin "github:ranxianglei/opencode-acp#2026-09-04_readme-which-do-i-need" --globalOption C — Download artifact
tar xzf opencode-acp-pr363.tgz
cp -r package/dist ~/.cache/opencode/packages/opencode-acp@latest/node_modules/opencode-acp/dist
This comment is automatically updated on each push. |
[bot] 🏷 PR #363 审核结论:✅ 通过(approve),无需改动。 纯文档改动,我逐项核对了 issue 里的每一条声明,全部属实。 核心声明 —— 跨仓库逐字一致(已独立验证)
位置(符合 issue 要求:放在 Installation 之前)
范围与合规
CI 门禁(check-pr.sh) GitHub CI(head 一点提醒(非阻塞): 表格里的排版细节(如 ZH 的半角逗号、括号前空格)是刻意跟 billion-context 保持逐字一致的,后续不要"顺手"规范化,否则就破坏了三仓库的口径统一。 按项目规范,合并由人来操作 —— 等 |
|
放在 为什么选择 ACP 后面吧 |
[bot] 🏷 已按你的要求把这节挪到「## Why ACP / ## 为什么选择 ACP」后面了(EN+ZH 都改)。
已推送新 commit |
背景
#362 —— 三个包(
billion-context/billion-context-pi/opencode-acp)经常被一起问「我该怎么选」。billion-context 的 README 已有定稿的同节(ranxianglei/billion-context#511,PR #512),本 PR 给 opencode-acp 加上同一节,跨仓库保持一致。改动
README.md:「## Proven at scale」与「## Installation」之间新增「## Which do I need?」节(issue 要求放在 Installation 之前)README.zh-CN.md:对应位置新增「## 该选哪个?」节devlog/2026-09-04_readme-which-do-i-need/:REQ.md + WORKLOG.md表格内容为 owner 在 #511 中定稿的四行选型表(pi / opencode / omp / 其余所有),每个项目带各自 GitHub 链接;已通过与 billion-context master 上已合入的同节(GitHub API 拉取)逐字比对一致。仅按本仓库排版习惯补了
---分隔线。只回答「什么时候选什么」,不展开原理(与 #511 精简后的口径一致)。验证
npm run typecheck✅npm run build✅npm run test✅ 1077 pass / 0 fail(全量回归)./scripts/ci/check-pr.sh✅ branch name / devlog / changelog 全过纯文档改动,不涉及代码、状态格式、配置;不动 version。
Fixes #362