Skip to content

docs: add "Which do I need?" section to READMEs (EN+ZH) - #363

Open
ranxianglei wants to merge 3 commits into
masterfrom
2026-09-04_readme-which-do-i-need
Open

docs: add "Which do I need?" section to READMEs (EN+ZH)#363
ranxianglei wants to merge 3 commits into
masterfrom
2026-09-04_readme-which-do-i-need

Conversation

@ranxianglei

Copy link
Copy Markdown
Owner

背景

#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

ework-agent added 2 commits September 4, 2026 14:22
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
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown

📦 Built Plugin Artifact

Branch: 2026-09-04_readme-which-do-i-need (4f68e39)

Option A — Install from npm PR tag (recommended)

opencode plugin opencode-acp@pr-363 --global

Each push to this PR publishes a new version under the pr-363 npm tag.

Option B — Install from GitHub

opencode plugin "github:ranxianglei/opencode-acp#2026-09-04_readme-which-do-i-need" --global

Option C — Download artifact

  1. Download the artifact from the Actions run
  2. Extract the tarball and install:
tar xzf opencode-acp-pr363.tgz
cp -r package/dist ~/.cache/opencode/packages/opencode-acp@latest/node_modules/opencode-acp/dist
  1. Restart opencode to pick up changes.

This comment is automatically updated on each push.

@ranxianglei

Copy link
Copy Markdown
Owner Author

🤖 ework agent · qwen3.8-27b

[bot] 🏷 PR #363 审核结论:✅ 通过(approve),无需改动。

纯文档改动,我逐项核对了 issue 里的每一条声明,全部属实。

核心声明 —— 跨仓库逐字一致(已独立验证)
通过 GitHub API 拉取 billion-context master 的 README.md / README.zh-CN.md,与本 PR 新增节逐字比对:

  • EN「Which do I need?」表头 + 四行数据(pi / opencode / omp / everything else)+ 四个 GitHub 链接 —— 与 billion-context 逐字节一致
  • ZH「该选哪个?」同上 —— 逐字节一致(含原文的半角逗号、( 前无空格等排版细节)。
  • 唯一差异是本仓库在节前/节后各补了一条 ---,与两个 README 里其它每个 H2 的分隔习惯完全吻合。这是符合预期的,不是偏差。

位置(符合 issue 要求:放在 Installation 之前)

  • EN:## Proven at scale## Which do I need?## Installation(README.md L44/L70/L83)
  • ZH:## 实战验证## 该选哪个?## 安装(README.zh-CN.md L36/L57/L70)

范围与合规

  • 只改了 4 个 markdown 文件:README.mdREADME.zh-CN.mddevlog/2026-09-04_readme-which-do-i-need/{REQ,WORKLOG}.md。无 package.json、无 lib/、零源码。
  • version 未动(1.14.27 保持不变),符合 AGENTS.md「feature PR 不 bump version」。
  • devlog 目录名 == 分支名,REQ/WORKLOG 齐全。

CI 门禁(check-pr.sh)
我在 PR head 的 worktree 上实跑了一遍(不是从旧 checkout 跑,否则会因工作树缺 devlog/version 不一致而误报):分支名 ✓、devlog ✓、version 未变跳过 changelog ✓ —— 全过

GitHub CI(head 156660d)
pr-validation ✅ · test (22) ✅ · test (24) ✅ · build-artifact ✅ · build ⏳ 仍在跑。即 Node 22/24 全量回归已通过(issue 里 1077 pass / 0 fail 的说法成立),目前只是 build 没跑完,所以 API 暂时显示 mergeable_state: blocked;跑完即转绿。

一点提醒(非阻塞): 表格里的排版细节(如 ZH 的半角逗号、括号前空格)是刻意跟 billion-context 保持逐字一致的,后续不要"顺手"规范化,否则就破坏了三仓库的口径统一。

按项目规范,合并由人来操作 —— 等 build 转绿后你可以直接合。合并后会自动关闭 #362

@ranxianglei

Copy link
Copy Markdown
Owner Author

放在 为什么选择 ACP 后面吧

@ranxianglei

Copy link
Copy Markdown
Owner Author

🤖 ework agent · qwen3.8-27b

[bot] 🏷 已按你的要求把这节挪到「## Why ACP / ## 为什么选择 ACP」后面了(EN+ZH 都改)。

  • README.md:现在顺序是 Why ACP → Which do I need? → Proven at scale → Installation
  • README.zh-CN.md:为什么选择 ACP → 该选哪个? → 实战验证 → 安装
  • 表格内容原样保留(仍与 billion-context 逐字一致),只动了位置;沿用本仓库的 --- 分隔习惯,无重复分隔线。
  • devlog(REQ.md/WORKLOG.md)已同步更新为新位置,并记了这条修订。

已推送新 commit 4f68e39(叠在原来那个 commit 之上,非 force-push),PR #363 的 head 已更新。本地 check-pr.sh 全过(分支名 / devlog / version 未动)。CI 会在新 commit 上重跑,跑完即可合并 —— 合并仍由你来点(规范限制我不能代合)。

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.

docs: README 增加「该选哪个?」一节,写清 opencode-acp / billion-context / billion-context-pi 何时选哪个

1 participant