Coder/deepseek-harness
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: anchor each subsystem page to its package group; make group READMEs thin tables

Browse Source 
core.md read as a type grab-bag: LLM wire vocabulary up front, the agent/loop story buried, and no correspondence to packages/core. It now opens on the packages/core control spine — the package-by-package loop map with a Page column into session/system-prompt/tools/scope — and keeps only what the spine group declares plus the repo-wide patterns: the Agent handle with its delivery/cancellation/interception contracts, the SessionEvent envelope, branded ids, the …Map pattern. The conversation vocabulary (Message/ContentBlock, the model request, adapters — 17 type-equiv blocks) moves to llm-streaming.md, which now declares packages/llm end-to-end; the duplicate ContentBlockMap paste near its seam section folds into the moved section, and the manifest, LINK_MAP, README table rows, website label (Core data structures → Core), and inbound anchors follow.

Every packages/<group>/README pair is now a thin front door in one shape: a why-first intro (bash's seam-pattern-first paragraph rewritten as 'shell execution for the agent'), the package table, and a closing pointer to the owning docs/subsystems page — the bash-style table stays the load-bearing middle. Load-bearing trailing paragraphs relocate rather than vanish: the fs no-timeout rationale becomes a filesystem.md section (both languages), session's four sectioned tables merge into one 12-row table, examples' legacy-bin H2 collapses to a pointer at jsonrpc-demo's README, and design rationale that already lives in an Agent Note or subsystem page is now linked instead of restated. All 40 pair records re-recorded.
This commit is contained in:
Tianyi Cui
2026-08-02 05:54:15 +08:00
parent 2886ba45db
commit aa0ca6c836
137 changed files with 1680 additions and 1507 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/support/README.i18n.yaml
View File

@@ -2,5 +2,5 @@
# side as of the last confirmed-consistent state. Both languages carry equal authority;
# after editing either side, bring the other along and re-record with:
# pnpm run verify-translation-pairing --write packages/support/README.md
README.md: 15cb82d3d76a1241af8b40e1c8536292618409a9
README.zh.md: ff8595b47f1a1220912dc77a072463adf74f7bf9
README.md: bf0bba1ea7d21700a6743195ec966512c20e01bc
README.zh.md: 47eba4d51c66914f388ba4a5925323173d5ed7e2

2
packages/support/README.md
View File

@@ -14,3 +14,5 @@ These packages support repository development, tests, and examples rather than p
| [`llm-replay/`](llm-replay/README.md) | Replays recorded model responses for keyless tests and demos |
A package moves out of `support/` when it gains a product contract and product consumers.
The invariants contract is documented in [docs/subsystems/invariants.md](../../docs/subsystems/invariants.md).

2
packages/support/README.zh.md
View File

@@ -14,3 +14,5 @@
| [`llm-replay/`](llm-replay/README.md) | 为无密钥测试和演示回放已记录的模型响应 |
当一个包获得产品契约和产品消费方时，它会移出 `support/`。
不变式契约记录在 [docs/subsystems/invariants.md](../../docs/subsystems/invariants.md)。