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

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

View File

@@ -156,30 +156,30 @@ export const LINK_MAP: Readonly<Record<string, string>> = {
AgentCancelCause: 'core.md',
AgentOptions: 'core.md',
AgentStatus: 'core.md',
ContentBlock: 'core.md',
ContentBlock: 'llm-streaming.md',
ContinuationDecision: 'core.md',
ContinuationStop: 'core.md',
GenerateOptions: 'core.md',
GenerateOptions: 'llm-streaming.md',
InboxItem: 'core.md',
InboxPlacement: 'core.md',
MessageId: 'core.md',
MessageId: 'llm-streaming.md',
HookContext: 'core.md',
SettleReason: 'core.md',
AdapterRegistrationHandle: 'core.md',
DirectoryRegistrationHandle: 'core.md',
LlmCallConfig: 'core.md',
LlmModelContext: 'core.md',
LlmModelReasoningInfo: 'core.md',
LlmResolvedModelInfo: 'core.md',
AdapterRegistrationHandle: 'llm-streaming.md',
DirectoryRegistrationHandle: 'llm-streaming.md',
LlmCallConfig: 'llm-streaming.md',
LlmModelContext: 'llm-streaming.md',
LlmModelReasoningInfo: 'llm-streaming.md',
LlmResolvedModelInfo: 'llm-streaming.md',
LlmFailure: 'llm-streaming.md',
LlmModelInfo: 'core.md',
LlmProviderInfo: 'core.md',
LlmConfigurableProvider: 'core.md',
LlmModelDiscoveryRequest: 'core.md',
LlmDiscoveredModel: 'core.md',
LlmModelInfo: 'llm-streaming.md',
LlmProviderInfo: 'llm-streaming.md',
LlmConfigurableProvider: 'llm-streaming.md',
LlmModelDiscoveryRequest: 'llm-streaming.md',
LlmDiscoveredModel: 'llm-streaming.md',
ResolvedRetryPolicy: 'llm-streaming.md',
Message: 'core.md',
MessageSource: 'core.md',
Message: 'llm-streaming.md',
MessageSource: 'llm-streaming.md',
UserMessage: 'session.md',
PreStepDecision: 'core.md',
PreStepContext: 'core.md',

View File

@@ -7,22 +7,17 @@
"source": "packages/util/brand/src/index.ts"
},
{
"doc": "docs/subsystems/core.md",
"symbol": "ContentBlockMap",
"source": "packages/llm/llm/src/types.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "AssistantProvenance",
"source": "packages/llm/llm/src/message.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "Message",
"source": "packages/llm/llm/src/message.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "MessageSourceMap",
"source": "packages/llm/llm/src/message.ts"
},
@@ -42,22 +37,22 @@
"source": "packages/llm/llm/src/message.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "FinishReasonMap",
"source": "packages/llm/llm/src/types.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "AdapterRegistrationHandle",
"source": "packages/llm/llm/src/index.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "LlmProviderInfo",
"source": "packages/llm/llm/src/types.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "LlmModelInfo",
"source": "packages/llm/llm/src/types.ts"
},
@@ -72,47 +67,47 @@
"source": "packages/llm/llm/src/types.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "LlmModelContext",
"source": "packages/llm/llm/src/types.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "ReasoningEffortId",
"source": "packages/llm/llm/src/brand.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "LlmReasoningEffortInfo",
"source": "packages/llm/llm/src/types.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "LlmModelReasoningInfo",
"source": "packages/llm/llm/src/types.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "LlmResolvedModelInfo",
"source": "packages/llm/llm/src/types.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "GenerateOptions",
"source": "packages/llm/llm/src/types.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "ToolSchema",
"source": "packages/llm/llm/src/types.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "LlmCallConfig",
"source": "packages/llm/llm/src/call-config.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "LlmCallConfigAdapterDefaults",
"source": "packages/llm/llm/src/call-config.ts"
},
@@ -1491,7 +1486,7 @@
"source": "packages/settings/settings/src/index.ts"
},
{
"doc": "docs/subsystems/core.md",
"doc": "docs/subsystems/llm-streaming.md",
"symbol": "LlmConfigurableProvider",
"source": "packages/llm/llm/src/types.ts"
},