Files
workdsh/docs/README.md
T

4.1 KiB

DSH Desktop 文档

English documentation

这里是 DSH Desktop 的产品与开发文档入口。根目录的 README.md 适合第一次了解项目;本目录解释项目为什么存在、如何使用,以及如何为 Desktop 编写插件。想参与贡献?见参与贡献。

按目标阅读

普通用户从用户指南开始即可,不需要阅读开发者文档。

用户文档

文档 你会得到什么
用户指南 安装、profile、模式、终端、插件命令和更新
常见问题 支持平台、内置环境、官方边界、数据、插件和更新的直接回答
为什么做 Desktop Desktop 与官方 Harness 的边界,以及为什么坚持插件化

开发者与维护者文档

文档 你会得到什么
插件生态倡议书 开放、可组合、可持续的插件生态愿景与三条原则
插件开发 普通 DSH 插件、Desktop 服务、兼容模式和生命周期
Community Fabric Draft 从 Manifest/Capability 基础,到 Runtime/Presentation、service composition 和溯源诊断的社区互操作提案
Fabric 社区意见处置记录 Issue #23 中哪些建议已采纳、拆成独立 RFC、延期或不进入可移植核心
Fabric 框架与插件需求调研 Koishi、Chrome、VS Code 的成熟模式,以及真实 DSH 插件的功能需求
VS Code 扩展模型调研 VS Code 已实现的声明、Provider、UI、运行位置和生命周期模式,以及它们对 Fabric RFC 的具体约束
Community Market 设计 规划中的插件市场壳、可扩展目录来源、用户选择、安装确认和安全边界
Market 目录提供方合同 面向后续实现团队的 Schema、query 参数、多来源和适配器规范
架构说明 Electron、Host、loopback Web、profile 和打包之间的关系
Desktop service 参考 desktopProfiles、desktopPnpm 的稳定 contract 和 TypeScript 示例
包级参考 完整的构建、运行、发布和已知限制

README 文件怎么分工

目前外层仓库有两份正式的产品 README,另保留一个旧链接兼容入口:

  • README.md:中文产品入口。
  • README.en.md:英文产品入口,与中文 README 保持同一产品范围。
  • README.zh.md:旧中文路径的兼容页,不维护独立内容。

README.i18n.yaml 只记录这两个正式入口的双语 hash,不是用户指南。dsh-plugin-desktop/README.md 和 dsh-plugin-desktop/README.zh.md 是 npm 包随包发布的包级参考;它们比根 README 更技术化。dsh-plugin-desktop/docs/ 是稳定 API 合同,不是营销页。.agents/notes/implemented/ 是日期化的维护者决策记录,适合追溯取舍,不替代用户文档。

deepseek-harness/ 是固定版本的官方上游子模块。它自己的 README 和 docs/ 属于上游项目,不能当作 Desktop 文档,也不在本仓库的产品文档统计中。

状态约定

文档会明确区分已实现能力、平台限制和 roadmap。Desktop 的兼容模式保留上游默认 Web 客户端;扩展窗口围绕完整上游布局加入倒 L 操作区域;增强模式安装 Desktop 自有布局。两种自定义窗口模式会按系统能力提供原生材质。插件市场已建立 dsh-community-market 文档初始化工程,但尚无可用页面或安装器;手机远程和 Channels 也仍是独立 roadmap,不代表当前安装包已经提供这些产品入口。