Repository navigation
[PR] docs: live architecture hub — overall diagram + module pages with diagrams + file-map CI guard - #5924
Conversation
4d1c3c0 to
f5269e4
Compare
…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.
78b94cc to
8d29ecd
Compare
…/architecture/assets/ (owner report: 整体架构不显示); guard now checks hub diagram links
(ai: vllm-qwen/qwen3.8-27b) 查重: 不重复 —— 本任务为既有 PR(上游 #5924)的合并冲突修复,未新建任何 issue/PR。 Conflict resolved. The PR ( Root cause: the base branch had itself been rebased onto newer master meanwhile, so three of the PR's lower commits were already contained in the base (two byte-identical by patch-id; the centralization commit replaced by a strict superset absorbing master-side changes from #5918/#5921). Only the top hub commit was genuinely new. What I did:
Check state now (mirror cache): 7 file-gated e2e 中文结构化结论(八问):
判定:冲突已解决,PR 恢复可合并状态(checks 排队中,0 失败);合并与否由 owner 决定。 |
…ure/, hub is in docs/ (owner report: docs/storage.md 不存在)
…, hub is in docs/ (owner report: storage.md 404)
[ework] CI fix verified green ✓ |
- 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
) The #5924 architecture-docs guard (landed on master via the branch sync) requires every tracked src/ file in reference/architecture.md; the new block-ops host executor module was added by this PR without its map row, so the guard failed on the merged head. One-line registration next to the acp-* cluster; guard passes locally (320 src files covered, no ghosts).
… the file map (#5767) The new anthropic-lane Claude Code auto-compact detector landed without a reference/architecture.md row, tripping the architecture-docs guard (#5924). Add the file-map entry; it is a small support module under the server/ group (no hub ledger row / module page needed, matching the other per-lane guard modules).
The architecture-docs CI lane (tools/check-architecture-docs.mjs, #5924) requires every tracked src/ file in the file map. The v6 lane added src/server/fastpath-v6.ts and src/server/fastpath-v6-render.ts without map rows, reding the lane on the merged head.
(ai: sglang-gpu0/qwen3.8-27b)
Owner request 2026-11-08: one architecture diagram (canonical), plus per-module docs — responsibility, basic principles, how-it-works — each with its own diagram, bilingual, live-maintained.
What this PR ships
1.
docs/architecture/becomes the live architecture hubdocs/architecture.md+architecture.zh-CN.md— the hub: overall architecture diagram (bilingual, vector-first) + module ledger (8 modules).docs/architecture/storage.md+storage.zh-CN.md(unified storage: responsibility / principles / how it works / hard invariants / key entries), with its own module diagram (bilingual).pipeline/lanes/kernel/identity/fastpaths/webui/update) land as follow-up PRs, one page + one diagram pair each; the hub table is the single ledger.2.
reference/architecture.mdfile map completed + CI-enforcedsrc/storage/layer,src/marker/, fastpath, lanes, snapshot-render, rollout, notices, …) — annotations written from the actual files; 2 stale entries for long-deleted files removed (image-compress.tsimage_full 无法被正确调用:同一张图每轮重复降采样(38 次)、restore 提示注入 38 次,模型只能猜 ref → 每轮一次失败+重发,缓存命中从 75% 掉到 28% #3266,external-summary-config.ts).src/file.3. Live-maintenance mechanism (the "实时维护" half)
architecture-docs(tools/check-architecture-docs.mjs, zero-dep node):src/files (no missing, no ghosts);.zh-CN), no orphan pages;&once shipped a broken English diagram — the check exists because of that).src/module or changes a depicted data flow / table / lane / wire path MUST update the page(s) + diagram(s) + ledger row + file map in the same PR. Visual freshness rides on that rule + review; the mechanical half is red-or-green in CI.docs/index.md/index.zh-CN.mdentries; CHANGELOG entry.Scope
Docs + one guard script + one CI job + AGENTS/CHANGELOG/index lines. No
src/behavior change, no config surface change, no kernel change. Stacked on the docs-centralization branch (base =2026-11-08_docs-centralization, PR #5920) so the hub lands on top of thedocs/hub structure; merge order: #5920 first.Verification
node tools/check-architecture-docs.mjs→ all green (map 305/305, ledger 8 modules / 1 active / page set matches, diagrams + SVG well-formedness).