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

0 Fork 0

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-09 01:32:39 +08:00

parent 2886ba45db

commit aa0ca6c836

137 changed files with 1680 additions and 1507 deletions

									
										docs/subsystems/session-reference.md
									
		+1
		-1
	
												View File
												
				@@ -102,7 +102,7 @@ async listCandidates( agent: Agent, query: string = '', limit: number = this.con

				async prepare( agent: Agent, content: ContentBlock[], references: SessionReferenceInput[], signal?: AbortSignal, ): Promise<PreparedReferencedMessage>

				```

				Types: [Agent](core.md) · [ContentBlock](core.md)

				Types: [Agent](core.md) · [ContentBlock](llm-streaming.md)

				Source: [`packages/context/session-reference/src/index.ts:70`](../../packages/context/session-reference/src/index.ts)

				<!-- END GENERATED cordis-surface -->