Skip to content

[PR] docs: land the stacked docs on master + add docs/README navigation page - #5936

Merged
ranxianglei merged 11 commits into
masterfrom
2026-11-08_docs-readme-nav
Nov 8, 2026
Merged

ranxianglei merged 11 commits into
masterfrom
2026-11-08_docs-readme-nav

Conversation

@ranxianglei

Copy link
Copy Markdown
Owner

(ai: sglang-gpu0/qwen3.8-27b)

两件事合在一个 PR 里,合入后这条文档线全部落地、master 与 feature 分支对齐:

1. 把已合并的文档栈搬上 master(搬运,零新内容)

刚才 #5934、#5924 两次合并按 GitHub 语义合进了 feature 分支(2026-11-08_docs-centralization),master 目前还停在 #5920——架构文档体系 + AGENTS.md 瘦身都还没上 master。本 PR 的 base 是 master、head 是该分支尖端 + 第 2 项的新提交,合入即全部落地:

2. 新增 docs/README.md 导航落地页(owner 指令 2026-11-08,本 PR 唯一新内容)

  • docs/README.md + docs/README.zh-CN.md(按 AGENTS §3 文档布局规则 1,双语默认):分区地图(start here / 系统架构 / 身份与协议 / 工程与运维)+ 五条目录规约(双语默认、必须进 index、架构文档 LIVE+CI、施工流程在 reference/、搬家留桩)。
  • docs/index.md / index.zh-CN.md 各加一行目录条目(规则 2:没进目录的文档等于不存在)。

验证

  • 4 个新/改文件全在 head 上;README 内相对链接自检:除 architecture 两链接外全部存在(architecture 两文件在本 PR head 上同在,合入后零 404)。
  • 纯文档,无代码/配置/wire 变化。

合入后

三个 feature 分支(2026-11-08_docs-centralization / 2026-11-08_architecture-docs / 2026-11-08_agents-md-slim)即可删除。

ranxianglei and others added 11 commits November 8, 2026 13:46
…rams, file-map CI guard (owner request 2026-11-08)
…NTS.md

Found during the #5924 conflict rebase: the hub commit added the same
Documentation Layout bullet twice (identical text back-to-back). Keep one.
…/architecture/assets/ (owner report: 整体架构不显示); guard now checks hub diagram links
…ure/, hub is in docs/ (owner report: docs/storage.md 不存在)
…, hub is in docs/ (owner report: storage.md 404)
- pipeline / lanes / kernel / identity / fastpaths / webui / update:
  en + zh-CN page each, structure = responsibility / principles / how it
  works / hard rules / key entries / related
- 14 module diagrams (svg primary + png fallback, one pair per module)
- hub ledger: all 8 rows active; CI guard checks the ledger <-> pages <->
  diagrams stay in lockstep
…, triage table to reference/triage.md (owner request 2026-11-08)
…deps; src/server/ + src/storage/ in module map, architecture-docs CI lane)
[PR] docs: slim AGENTS.md — KDD full text to reference/design-decisions.md, triage table to reference/triage.md
[PR] docs: live architecture hub — overall diagram + module pages with diagrams + file-map CI guard
@github-actions

github-actions Bot commented Nov 8, 2026

Copy link
Copy Markdown
Contributor

📦 Built Package Artifact

Branch: 2026-11-08_docs-readme-nav (6f4f248)

Latest build — install this exact version

npm install -g billion-context@0.0.8603-pr.5936.24a456d

This exact version is immutable and reproducible. The rolling pr tag tracks the newest test build across all PRs.

Recent builds (commit → version)

commit version build
6f4f248 billion-context@0.0.8603-pr.5936.24a456d build

Download artifact

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

Install instructions are refreshed on each push.

@ranxianglei
ranxianglei merged commit f2ce676 into master Nov 8, 2026
47 checks passed
@ranxianglei ranxianglei changed the title docs: land the stacked docs on master + add docs/README navigation page [PR] docs: land the stacked docs on master + add docs/README navigation page Nov 8, 2026
@ranxianglei

Copy link
Copy Markdown
Owner Author

🤖 Powered by ework · qwen3.8-27b

[bot] 🏷 (ai: qwen3.8-27b)

结论:这条文档线已经全部落地并合入 master,无需再做任何改动。 以下是我刚拉取的实时核实结果(非凭记忆):

  • PR [PR] docs: land the stacked docs on master + add docs/README navigation page #5936 已合入:GitHub API 返回 state=closed, merged=true,合入时间 2026-11-08T08:40:25Z(本地 16:40,约在我被唤醒前 7 分钟),merge commit f2ce676989。
  • 交付物全部在 master 上(逐项核对 origin/master 树):
    • 第 1 项「搬运」:架构文档体系(hub docs/architecture.md[+zh] + 8 个模块页 en/zh + 全套 svg/png 图)、reference/design-decisions.md、reference/triage.md、瘦身后的 AGENTS.md、architecture-docs CI 守卫(tools/check-architecture-docs.mjs + .github/workflows/ci.yml)。
    • 第 2 项「新增」:docs/README.md + docs/README.zh-CN.md 双语导航落地页,以及 docs/index.md / index.zh-CN.md 各一行目录条目。
  • 链接零 404:两个 README 的全部相对链接逐一解析通过(en 25 / zh 25),含正文预告的 2 条 architecture 链接——已随本次合入在 master 上同在。
  • CI 绿:[PR] docs: land the stacked docs on master + add docs/README navigation page #5936 head 的 49 个 check-run = 37 success + 12 skipped,0 失败。

剩余一件可选收尾(我未代做):正文提到合入后三个 feature 分支可删(2026-11-08_docs-centralization / 2026-11-08_architecture-docs / 2026-11-08_agents-md-slim)。这属于你仓库的分支清理、且是「即可删除」的许可而非指令,我没有擅自删;需要的话说一声我下一条直接清掉。


结构化八问

  1. 是什么问题:把此前按 GitHub 语义只合进 feature 分支尖端的文档栈(架构文档体系 + AGENTS.md 瘦身)搬上 master,并按 owner 指令补一个 docs/README 双语导航落地页。
  2. 什么原因导致的:[PR] docs: live architecture hub — overall diagram + module pages with diagrams + file-map CI guard #5924/[PR] docs: slim AGENTS.md — KDD full text to reference/design-decisions.md, triage table to reference/triage.md #5934 两次合并落到了 feature 分支尖端而非 master,master 停在 [PR] docs: batch-migrate 14 root-level documents into docs/ (consolidation + master index + redirect placeholders) | docs: 14 个根级文档一次性迁入 docs/(集中 + 总目录 + 重定向占位) #5920,导致架构文档与瘦身尚未对 master 生效——是合并目标分支选择的产物,非代码缺陷。
  3. 影响范围与严重程度:纯文档,无代码/配置/wire 变化;仅影响 master 上的文档可读性与导航,属内部实现层、无运行时用户面影响。
  4. 怎么修复的:以 master 为 base、feature 分支尖端 + README 新提交为 head 开一个 PR,一次合入即把整条文档线对齐 master(第 1 项搬运零新内容 + 唯一新增为 README 导航页)。
  5. 是否有回归问题:无。逐条核对被触碰路径的既有行为——文档搬家保留根目录重定向桩、index 条目齐全、architecture-docs 守卫在位且链接全解析;无语义漂移、fail-fast 变吞错、阈值/时序/输出格式变化。
  6. 是否破坏缓存:不涉及(纯文档,不触碰缓存/重试/游标/去重键)。
  7. 是否改了设计方向:不涉及架构转向;仅确立「docs/ 为唯一文档 hub + reference/ 放施工流程」的布局规约(已由 [PR] docs: batch-migrate 14 root-level documents into docs/ (consolidation + master index + redirect placeholders) | docs: 14 个根级文档一次性迁入 docs/(集中 + 总目录 + 重定向占位) #5920/[PR] docs: live architecture hub — overall diagram + module pages with diagrams + file-map CI guard #5924 定稿,本 PR 将其落地)。
  8. 是否引入了新的配置:不涉及(无 env/config/CLI/默认值变更)。

判定:收工。 交付物已合入且验证齐全,master 与 feature 分支已对齐;仅剩上面那条可选的分支清理待你点头。

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