# 文档索引 / Documentation index

根 README 只列"有什么"，细节都在这里。中文文档没有后缀，英文文档是 `.en.md`。
The root README lists what ships; the details live here. Chinese files have no suffix, English files use `.en.md`.

## 上手 / Get started

| 文档 / Doc | 中文 | English | 讲什么 / What it covers |
| --- | --- | --- | --- |
| 安装与快速开始 / Install & run | [getting-started.md](getting-started.md) | [getting-started.en.md](getting-started.en.md) | 从安装、启动到排障。 |
| 会话迁移 / Session migration | [migrate.md](migrate.md) | [migrate.en.md](migrate.en.md) | 从 Claude Code / Codex / OMP / zcode / Grok Build 导入对话历史。 |
| VS Code | [vscode.md](vscode.md) | [vscode.en.md](vscode.en.md) | 在 VS Code 里跑，配合扩展与 IDE 选区。 |

## 日常使用 / Using it

| 文档 / Doc | 中文 | English | 讲什么 / What it covers |
| --- | --- | --- | --- |
| 使用说明 / User guide | [user-guide.md](user-guide.md) | [user-guide.en.md](user-guide.en.md) | 键位、命令、会话工作流与设置。 |
| 交互与命令 / Interaction & commands | [interaction.md](interaction.md) | [interaction.en.md](interaction.en.md) | 键位、鼠标、问卷审批与 slash 命令。 |
| 自动化 CLI / Automation CLI | [cli.md](cli.md) | [cli.en.md](cli.en.md) | 无界面执行、管理查询、版本化输出与官方转接。 |
| 主题系统 / Themes | [themes.md](themes.md) | [themes.en.md](themes.en.md) | 内置主题、自动检测与自定义主题。 |
| Claude 后端（实验性）/ Claude backend (experimental) | [claude-backend.md](claude-backend.md) | [claude-backend.en.md](claude-backend.en.md) | 启用、登录、与 DSH 的差异和已知限制。 |
| Codex 原生后端（实验性）/ Native Codex backend (experimental) | [codex-backend.md](codex-backend.md) | [codex-backend.en.md](codex-backend.en.md) | 安装、登录/渠道、Plan/权限、原生会话与当前验证边界。 |

## 配置 / Configuration

| 文档 / Doc | 中文 | English | 讲什么 / What it covers |
| --- | --- | --- | --- |
| 配置参考 / Configuration | [configuration.md](configuration.md) | [configuration.en.md](configuration.en.md) | 覆盖层、TUI 开关、Agent preset 与 MCP。 |

## 实现 / Internals

| 文档 / Doc | 中文 | English | 讲什么 / What it covers |
| --- | --- | --- | --- |
| 架构与限制 / Architecture & limitations | [architecture.md](architecture.md) | [architecture.en.md](architecture.en.md) | 运行链路、性能、安全边界与已知限制。 |
| 会话挂载运行时 / Session mount runtime | [session-mount-runtime.md](session-mount-runtime.md) | [session-mount-runtime.en.md](session-mount-runtime.en.md) | 多 TUI 占用规则与本机账本。 |
| 首次引导的账号与模型接入 / Onboarding provider setup | [onboarding-provider-setup.md](onboarding-provider-setup.md) | [onboarding-provider-setup.en.md](onboarding-provider-setup.en.md) | 引导第一步如何登录账号、写入凭据并选出默认模型。 |
| 独立宿主设计 / Standalone host design | [standalone-host-design.md](standalone-host-design.md) | — | 本包自持入口与组装根、DSH 进程内加载的方案与决策。 |
| 多后端架构 / Agent backends | [agent-backend-design.md](agent-backend-design.md) | — | 后端中立层、DSH/Claude/Codex 的实现与接入新后端。 |
| Codex 后端方案 / Codex backend design | [codex-backend-design.md](codex-backend-design.md) | — | Codex（app-server）原生后端的技术方案与分期实施手册。 |
| Agent Teams 支持 / Agent Teams support | [agent-teams-design.md](agent-teams-design.md) | — | DSH 实验性 Agent Teams 的开启方式、读侧投影、实测事实与分期计划。 |
| Codex 后端交接 / Codex backend handoff | [codex-backend-handoff.md](codex-backend-handoff.md) | — | 当前进度、剩余工作、新机器准备与实测配置（接手者先读）。 |
| Codex 后端施工日志 / Codex backend progress | [codex-backend-progress.md](codex-backend-progress.md) | — | 逐期记录：实测结论、决策、门禁结果与偏离。 |
| 子代理转录页数据源 / DSH child transcript | [dsh-child-transcript.md](dsh-child-transcript.md) | — | DSH 子会话转录的读取契约与新后端接入清单。 |

## 插件 / Plugins

| 文档 / Doc | 中文 | English | 讲什么 / What it covers |
| --- | --- | --- | --- |
| 插件准入与开发 / Plugin admission & development | [仓内 TUI Profile](../tui-profile/docs/plugin-admission-and-development.md) | [TUI Profile](../tui-profile/docs/plugin-admission-and-development.md) | 接缝、契约与验证清单。 |
| 插件速览 / Plugin overview | [plugins.md](plugins.md) | [plugins.en.md](plugins.en.md) | 生态入口与接缝稳定性分级。 |

## 参与 / Contributing

| 文档 / Doc | 中文 | English | 讲什么 / What it covers |
| --- | --- | --- | --- |
| 贡献与开发约定 / Contributing | [contributing.md](contributing.md) | [contributing.en.md](contributing.en.md) | 贡献流程、仓库地图与验证矩阵。 |
| 社区管理框架 / Community management | [community-management.md](community-management.md) | [community-management.en.md](community-management.en.md) | 社区入口、角色与提案流程。 |
| 项目路线图 / Roadmap | [roadmap.md](roadmap.md) | [roadmap.en.md](roadmap.en.md) | 公开目标、阶段、退出条件。 |
| 行为准则 / Code of conduct | [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md) | [CODE_OF_CONDUCT.en.md](../CODE_OF_CONDUCT.en.md) | 参与社区的言行准则。 |

## 快速入口 / Quick links

- 中文项目首页 [README_ZH.md](../README_ZH.md) · English project page [README.md](../README.md)
- npm 包：[`@deepseek-harness-tui/dsh-tui`](https://www.npmjs.com/package/@deepseek-harness-tui/dsh-tui)
- DeepSeek Harness 配置目录：[官方参考](https://deepseek-harness.github.io/deepseek-harness/reference/config-catalog)

> 文档描述当前仓库版本；配置行为以 `package.json`、`cordis.patch.yml`、`src/index.ts` 与实际 DSH 组合为准。
> These guides describe the current repository version; configuration behavior is governed by `package.json`, `cordis.patch.yml`, `src/index.ts` and the active DSH composition.