cc-haha/docs/en/internals/structure.md
程序员阿江(Relakkes) c2cd615824 docs: rebuild the documentation site around two readers
The site had drifted from the product. Every screenshot predated the
v0.5.0 UI redesign, the reading experience shipped no search and no
syntax highlighting, and a third of the pages were internal process
artefacts — migration task lists addressed to agentic workers, a
release runbook, a proposal marked "historical".

Reorganise around the only two people who read this: someone getting
the desktop app running for the first time, and someone reading the
source. Five sections replace nine — start / desktop / im / cli /
internals — and the pages that served neither reader are gone.

Site rewrite:

- Palette lifted from the desktop app's 「纸·墨·印」 themes, so the
  site and the product read as one thing. Light mirrors 纯白, dark
  mirrors 墨夜, and dark mode exists at all now.
- Fonts are self-hosted. The old @import from Google Fonts is
  unreachable from mainland China, which left every heading in a
  fallback serif; it also only requested weight 600 while the CSS
  asked for 900, so Latin and CJK in the same heading disagreed.
- Docs were shipped as one 968KB manifest downloaded on every page
  view. Split into a 32KB index plus one lazily imported chunk per
  page; the entry bundle is now 101KB gzipped.
- Add search, syntax highlighting, per-route meta with canonical and
  hreflang, a sitemap, and an error boundary. Replace the 44vh
  mobile sidebar with a drawer.
- Image dimensions are read at build time and written into the tag,
  so lazy images reserve their space instead of collapsing.

Screenshots are recaptured from a real v0.5.0 build against a clean
demo project, with tokens, QR codes and paired accounts redacted.
The previous set is deleted rather than kept alongside.

Routes follow file paths, so the restructure would have broken every
inbound link; 37 old paths redirect, in both languages. The PR policy
gate and CODEOWNERS also hardcoded docs/guide/contributing.md.

Verified: check:docs 78 pages / 323 links / 0 problems, check:policy
127 pass. Walked every route at 1440 and 390 in both themes for
overflow, contrast, keyboard reachability and focus management.
2026-07-27 17:32:41 +08:00

4.9 KiB

title nav_title description order
Project Structure Structure Responsibility boundaries across the CLI, server, desktop app, adapters, and docs site. 3

Project Structure

The repository contains the CLI/TUI, local Server, Electron desktop app, IM adapters, and documentation site. This map lists stable responsibility boundaries rather than every file.

.
├── bin/
│   └── claude-haha                 # CLI launcher
├── preload.ts                      # Bun preload and build compatibility entry
├── package.json                    # Root scripts and dependencies
├── src/
│   ├── entrypoints/
│   │   └── cli.tsx                 # Main CLI entry
│   ├── main.tsx                    # TUI flow
│   ├── setup.ts                    # Startup initialization
│   ├── screens/                    # REPL and other terminal screens
│   ├── components/                 # Ink UI components
│   ├── tools/                      # Agent tools such as Bash, Edit, and Grep
│   ├── commands/                   # Slash commands
│   ├── services/                   # Shared Provider, MCP, and OAuth services
│   ├── utils/                      # Runtime utilities and Computer Use integration
│   ├── vendor/                     # Controlled vendored implementations
│   └── server/
│       ├── index.ts                # Bun.serve HTTP/WebSocket entry
│       ├── router.ts               # REST resource routing
│       ├── api/                    # API boundaries
│       ├── services/               # Session, Provider, index, and diagnostics services
│       ├── ws/                     # WebSocket protocol and lifecycle
│       ├── proxy/                  # Provider protocol conversion
│       ├── middleware/             # Auth and CORS
│       └── config/                 # Provider presets
├── desktop/
│   ├── src/                        # React Renderer
│   │   ├── api/                    # Server API and WebSocket clients
│   │   ├── components/             # Chat, Workspace, Browser, and layout
│   │   ├── features/               # Isolated features such as Pets
│   │   ├── pages/                  # Sessions, Settings, tasks, diagnostics
│   │   ├── stores/                 # Zustand state
│   │   ├── i18n/                   # Desktop locales
│   │   └── lib/                    # Renderer runtime utilities
│   ├── electron/
│   │   ├── main.ts                 # Electron main entry
│   │   ├── preload.ts              # Main-window Host bridge
│   │   ├── preview-preload.ts      # Native preview bridge
│   │   ├── pet-preload.ts          # Pet-window bridge
│   │   ├── ipc/                    # IPC channels and validation
│   │   └── services/               # Sidecar, terminal, updater, and preview services
│   ├── sidecars/
│   │   └── claude-sidecar.ts       # Unified server / cli / adapters entry
│   ├── scripts/                    # Build, packaging, and resource preparation
│   └── src-tauri/                  # Historical code and current package resources; not the Host
├── adapters/
│   ├── common/                     # Shared config, pairing, messaging, and WS bridge
│   ├── telegram/
│   ├── feishu/
│   ├── wechat/
│   ├── dingtalk/
│   └── whatsapp/
├── runtime/
│   ├── mac_helper.py               # macOS Computer Use helper
│   ├── win_helper.py               # Windows Computer Use helper
│   ├── requirements.txt
│   └── requirements-win.txt
├── scripts/                        # Root quality, release, and maintenance scripts
├── tests/                          # Cross-module tests and fixtures
├── site/                           # React docs site, content index, and static build
└── docs/                           # Chinese and English Markdown content

Runtime boundaries

Entry Runtime Responsibility
src/entrypoints/cli.tsx Bun CLI/TUI and Agent tools
src/server/index.ts Bun / Bun.serve Local HTTP, WebSocket, and H5
desktop/electron/main.ts Electron main Native desktop Host
desktop/src/ Chromium Renderer React desktop UI
desktop/sidecars/claude-sidecar.ts Bun-compiled Sidecar Packaged Server, CLI, and Adapter entry
adapters/<platform>/ Bun Sidecar Platform messaging integration

Place new code at the boundary that owns the responsibility: native desktop capabilities belong in desktop/electron/, shared business APIs in src/server/, and platform-specific messaging behavior in adapters/<platform>/. The Renderer should not bypass these boundaries.