Skip to content

docs: move mechanism details out of Quickstart into TECHNICAL-NOTES (#985) - #996

Merged
ranxianglei merged 2 commits into
masterfrom
2026-09-19_readme-tech-docs-split
Sep 19, 2026
Merged

ranxianglei merged 2 commits into
masterfrom
2026-09-19_readme-tech-docs-split

Conversation

@ranxianglei

@ranxianglei ranxianglei commented Sep 19, 2026 •

Copy link
Copy Markdown
Owner

Ref #985

Follow-up refactor requested on #985 after #986 merged: the Runtime-info 协议(#955) section sat in the middle of the three usage options in Quickstart. Technical-detail material belongs in its own document; the three options should stay concise.

What changed (zh/en in sync)

New docs: TECHNICAL-NOTES.md + TECHNICAL-NOTES.zh-CN.md

README.md / README.zh-CN.md (Quickstart stays concise)

  • Option 1: mechanism paragraph trimmed to a few lines + link; the #### Runtime-info protocol (#955) subsection replaced by one summary sentence + link; the claude note bullet trimmed to a few lines + link
  • ### Injection priority (#535) removed from between Option 1 and Option 2
  • One pointer line under the Quickstart option list names the new doc
  • Verify step moved into Option 3 (URL change) — its precondition ("config saved") is exactly Option 3's flow, but it was placed after the dsh/Kimi client sections where it read like client content (follow-up from 更新readme 尤其是opencodev2使用方式,尤其是v2版本 #985 review). Text unchanged, now closes Option 3 as its final step.

CONFIGURATION.md / CONFIGURATION.zh-CN.md: two cross-references pointed at the removed README "Injection priority" section — now point at TECHNICAL-NOTES.

No content lost: every moved sentence went into the new doc / new location verbatim. Docs-only change — zero source/wire/config impact.

Base: current master (3859b97, includes #995/#1005/#1007 — rebased, one README conflict resolved by union: kept the new Single-writer (#991) section + this PR's trimmed paragraph). Two commits, clean diff (6 files).

@github-actions

github-actions Bot commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

📦 Built Package Artifact

Branch: 2026-09-19_readme-tech-docs-split (bbb78ff)

Option A — Install from npm PR tag (recommended)

npm install -g billion-context@pr-996

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

Option B — Download artifact

  1. Download the artifact from the Actions run
  2. Extract the tarball and install:
tar xzf billion-context-pr996.tgz
npm install -g package

Install instructions are refreshed on each push.

@ranxianglei

Copy link
Copy Markdown
Owner Author

🤖 Powered by ework · qwen3.8-27b

[bot] 🏷 Reviewed PR #996 (2026-09-19_readme-tech-docs-split, single commit 7d75e89 on current master 95451f2, which includes merged #986). Verified against the branch, not just the description:

Diff cleanliness ✅

  • Exactly 6 files, +149/−99, all markdown: README.md, README.zh-CN.md, CONFIGURATION.md, CONFIGURATION.zh-CN.md, new TECHNICAL-NOTES.md, new TECHNICAL-NOTES.zh-CN.md. Zero source/wire/config impact — genuinely docs-only.
  • No unrelated churn, no whitespace noise; every line relates to the split.

No content lost ✅ — I diffed every removed line from both old READMEs against the new doc. Everything moved is present verbatim, with only three intentional structural deltas:

  1. Section headings promoted (####/### in README → ## in the new doc) — expected.
  2. The claude bullet's lead-in ("also has a native posture ([native] claude: three-mode alignment (proxy / launcher / native plugin) + runtime-info #964, hybrid)") became the section heading "Claude native posture ([native] claude: three-mode alignment (proxy / launcher / native plugin) + runtime-info #964)" — the word hybrid dropped in both languages; all mechanics (port override chain, passthrough opt-out, JSON merge/strip, bili claude coexistence) preserved. Fine.
  3. One trivial zh word-order tweak in the lifecycle paragraph (并把… /acp 面板绑定到当前会话) — zero semantic loss.

Quickstart stays concise ✅

  • Option 1: mechanism paragraph trimmed, runtime-info subsection replaced by one summary sentence + link, claude bullet trimmed + link, ### Injection priority (#535) removed from between Option 1 and Option 2, pointer line added under the option list. zh mirror identical in structure.

Cross-references ✅

  • Both CONFIGURATION refs now point at TECHNICAL-NOTES(.zh-CN); grep across the whole tree finds no stale links to the removed README sections.

CI ✅ — all checks green on 7d75e89: test matrix (ubuntu 22/24, windows 22/24), codex e2e zero-token preflight, CODEX_HOME overlay test, build-artifact, version-guard. PR is mergeable against current master.

中文摘要:纯文档重构,把 Quickstart 里的机制细节(插件生命周期、runtime-info 协议 #955、claude 原生姿态 #964、注入优先级 #535)原样搬进新的 TECHNICAL-NOTES(中英同步),逐行核对无内容丢失、无残留失效引用,CI 全绿,可以合并。

Merging stays your call: #996

@ranxianglei
ranxianglei force-pushed the 2026-09-19_readme-tech-docs-split branch from 7d75e89 to bbb78ff Compare September 19, 2026 13:09
@ranxianglei
ranxianglei merged commit 23df1ef into master Sep 19, 2026
8 checks passed
@ranxianglei ranxianglei mentioned this pull request Sep 19, 2026
@ranxianglei
ranxianglei deleted the 2026-09-19_readme-tech-docs-split branch October 15, 2026 05:32
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.

1 participant