Files
workdsh/docs
t4we fan 3cfb09fcbc docs: separate user-facing and developer documentation paths
Users following the install/use path could previously land in developer
and maintainer content: the root README documentation table mixed both
audiences, the plugin-ecosystem section named desktopProfiles/desktopPnpm
inline, the user guide ended by pointing at the package README, and
why-desktop carried contract details.

Split the root README and docs index into user vs developer tables, add a
user-level plugin intro to the user guide, remove the developer-jargon
patch wording, and soften why-desktop's developer-contract detail. The
plugin-ecosystem narrative and differentiation copy stay for a follow-up
pass.
2026-08-16 19:10:51 +08:00
..

DSH Desktop Documentation

中文文档

This directory is the product and developer documentation index for DSH Desktop. The root README.en.md is the short product entry point; these pages explain why the project exists, how to use it, and how to build plugins for it.

Read by goal

Ordinary users can start with the user guide and never need the developer documentation.

User documentation

Document Covers
User guide Installation, profiles, modes, terminal, plugins, and updates
Why Desktop The boundary with upstream Harness and the case for plugins

Developer and maintainer documentation

Document Covers
Plugin development Ordinary DSH plugins, Desktop services, compatibility, and lifecycle
Architecture Electron, Host, loopback Web, profiles, and packaging
Desktop service reference Stable desktopProfiles and desktopPnpm contracts with TypeScript examples
Package reference Detailed build, runtime, release, and limitation notes

How the README files are organized

The outer repository has two formal product READMEs plus one legacy compatibility entry:

  • README.md: the Chinese product entry point.
  • README.en.md: the English product entry point with the same product scope.
  • README.zh.md: a legacy Chinese-path compatibility page with no independent content.

README.i18n.yaml records the bilingual blob hashes for those two formal entry points; it is not a user guide. dsh-plugin-desktop/README.md and dsh-plugin-desktop/README.zh.md ship with the npm package and are the more technical package reference. dsh-plugin-desktop/docs/ contains stable API contracts rather than marketing copy. .agents/notes/implemented/ contains dated maintainer decision records and does not replace user documentation.

deepseek-harness/ is the pinned upstream submodule. Its README and docs/ belong to the upstream project, not to the Desktop product, and are excluded from the outer documentation inventory.

Status convention

These pages distinguish shipped behavior, platform limits, and roadmap items. Compatibility mode keeps the upstream default Web client; advanced mode installs the Desktop-owned layout and native materials. The plugin marketplace, mobile remote control, and Channels remain separate roadmap items and are not implied to be part of the current installer.