docs: give subsystems/ its own README index; retire the data-structures-catalog framing

core.md doubled as the folder index: its intro claimed "this folder catalogs the data structures" and carried the 38-row page table, wording that predates the one-page-per-subsystem shape where every page also carries its generated Cordis surface. The folder index now lives in docs/subsystems/README.md (page table plus the type-equiv note), and core.md is one subsystem page among siblings: the spine vocabulary. Structural referents move with it: the docs/AGENTS.md tier table and update rule, development.md's type-equiv pointer, the dsh-code-review skill, the two owning catalog Agent Notes, and website/docs.ts (README projects as reference/subsystems/index.md and takes the docs/subsystems folder alias; sidebar orders shift by one). Remaining "data-structure catalog" / "sub-page" phrasing in active notes and READMEs is reworded to subsystem-page terms in both languages; touched pairs re-recorded; translation-prompt snapshot re-recorded (its example embeds development.md).
This commit is contained in:
Tianyi Cui
2026-08-02 03:48:16 +08:00
parent f7323354bb
commit 2886ba45db
27 changed files with 198 additions and 190 deletions

View File

@@ -257,52 +257,54 @@ const cordisPrimerReference = pairedPages([
},
])
const coreDataReference = pairedPages(([
['core.md', '核心数据结构', 'Core data structures', 0],
['scope.md', '作用域', 'Scopes', 1],
['session.md', '会话', 'Sessions', 2],
['session-query.md', '会话查询', 'Session query', 3],
['session-reference.md', '会话引用', 'Session references', 4],
['session-title.md', '会话标题', 'Session titles', 5],
['settings.md', '用户设置', 'User settings', 6],
['credentials.md', '用户凭据', 'User credentials', 7],
['system-prompt.md', '系统提示词', 'System prompts', 8],
['tools.md', '工具', 'Tools', 9],
['llm-streaming.md', 'LLM 流式响应', 'LLM streaming', 10],
['token-meter.md', 'Token 计量', 'Token metering', 11],
['bash.md', 'Bash 执行', 'Bash execution', 12],
['subprocess.md', '子进程', 'Subprocesses', 13],
['tasks.md', '后台任务', 'Background tasks', 14],
['filesystem.md', '文件系统', 'Filesystem', 15],
['lsp.md', 'LSP 导航', 'LSP navigation', 16],
['code-runtime.md', '代码运行时', 'Code runtime', 17],
['compaction.md', '上下文压缩', 'Compaction', 18],
['subagent.md', '子代理', 'Subagents', 19],
['workflow.md', '工作流', 'Workflows', 20],
['skills.md', '技能', 'Skills', 21],
['approval.md', '审批', 'Approvals', 22],
['permission.md', '权限预设', 'Permission presets', 23],
['plan.md', '计划模式', 'Plan mode', 24],
['user-interaction.md', '用户交互', 'User interaction', 25],
['sandbox.md', '沙箱', 'Sandboxing', 26],
['web.md', 'Web 访问', 'Web access', 27],
['spill.md', 'Spill 存储', 'Spill storage', 28],
['persistence.md', '会话持久化', 'Session persistence', 29],
['storage.md', '存储', 'Storage', 30],
['workspace.md', '工作区', 'Workspaces', 31],
['http-server.md', 'HTTP 服务器', 'HTTP server', 32],
['client-modules.md', '客户端模块', 'Client modules', 33],
['invariants.md', '运行时不变式', 'Runtime invariants', 35],
['session-projection.md', '会话投影', 'Session projections', 36],
['telemetry.md', '遥测', 'Telemetry', 37],
const subsystemsReference = pairedPages(([
['README.md', '子系统', 'Subsystems', 0],
['core.md', '核心数据结构', 'Core data structures', 1],
['scope.md', '作用域', 'Scopes', 2],
['session.md', '会话', 'Sessions', 3],
['session-query.md', '会话查询', 'Session query', 4],
['session-reference.md', '会话引用', 'Session references', 5],
['session-title.md', '会话标题', 'Session titles', 6],
['settings.md', '用户设置', 'User settings', 7],
['credentials.md', '用户凭据', 'User credentials', 8],
['system-prompt.md', '系统提示词', 'System prompts', 9],
['tools.md', '工具', 'Tools', 10],
['llm-streaming.md', 'LLM 流式响应', 'LLM streaming', 11],
['token-meter.md', 'Token 计量', 'Token metering', 12],
['bash.md', 'Bash 执行', 'Bash execution', 13],
['subprocess.md', '子进程', 'Subprocesses', 14],
['tasks.md', '后台任务', 'Background tasks', 15],
['filesystem.md', '文件系统', 'Filesystem', 16],
['lsp.md', 'LSP 导航', 'LSP navigation', 17],
['code-runtime.md', '代码运行时', 'Code runtime', 18],
['compaction.md', '上下文压缩', 'Compaction', 19],
['subagent.md', '子代理', 'Subagents', 20],
['workflow.md', '工作流', 'Workflows', 21],
['skills.md', '技能', 'Skills', 22],
['approval.md', '审批', 'Approvals', 23],
['permission.md', '权限预设', 'Permission presets', 24],
['plan.md', '计划模式', 'Plan mode', 25],
['user-interaction.md', '用户交互', 'User interaction', 26],
['sandbox.md', '沙箱', 'Sandboxing', 27],
['web.md', 'Web 访问', 'Web access', 28],
['spill.md', 'Spill 存储', 'Spill storage', 29],
['persistence.md', '会话持久化', 'Session persistence', 30],
['storage.md', '存储', 'Storage', 31],
['workspace.md', '工作区', 'Workspaces', 32],
['http-server.md', 'HTTP 服务器', 'HTTP server', 33],
['client-modules.md', '客户端模块', 'Client modules', 34],
['tui.md', 'TUI 扩展', 'TUI extensions', 35],
['invariants.md', '运行时不变式', 'Runtime invariants', 36],
['session-projection.md', '会话投影', 'Session projections', 37],
['telemetry.md', '遥测', 'Telemetry', 38],
] as const).map(([file, rootLabel, enLabel, order]): PairedPage => ({
source: `docs/subsystems/${file}`,
route: `reference/subsystems/${file}`,
route: file === 'README.md' ? 'reference/subsystems/index.md' : `reference/subsystems/${file}`,
label: { root: rootLabel, en: enLabel },
sidebar: { root: 'zh-reference', en: 'en-reference' },
section: { root: '子系统', en: 'Subsystems' },
order,
...(file === 'core.md' ? { sourceAliases: ['docs/subsystems'] } : {}),
...(file === 'README.md' ? { sourceAliases: ['docs/subsystems'] } : {}),
})))
const reference = mirroredPages([
@@ -351,9 +353,9 @@ const reference = mirroredPages([
order,
})),
...([
['goal.md', '目标', 'Goals', 13],
['pty.md', 'PTY 会话', 'PTY sessions', 25],
['commands.md', '命令', 'Human commands', 37],
['goal.md', '目标', 'Goals', 14],
['pty.md', 'PTY 会话', 'PTY sessions', 26],
['commands.md', '命令', 'Human commands', 38],
] as const).map(([file, rootLabel, enLabel, order]): MirroredPage => ({
source: `docs/subsystems/${file}`,
route: `reference/subsystems/${file}`,
@@ -385,6 +387,6 @@ export const docsPages: DocsPage[] = [
...develop,
...cordisTutorial,
...cordisPrimerReference,
...coreDataReference,
...subsystemsReference,
...reference,
]