mirror of
https://github.com/CherryHQ/cherry-studio.git
synced 2026-07-05 13:47:59 +08:00
32a6666bb3
Co-authored-by: jdzhang <625013594@qq.com> Co-authored-by: gujiaming <52187003+AtomsH4@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Co-authored-by: kangfenmao <kangfenmao@qq.com> Co-authored-by: jd <59188306+zhangjiadi225@users.noreply.github.com> Co-authored-by: fullex <106392080+0xfullex@users.noreply.github.com> Signed-off-by: gujiaming <52187003+AtomsH4@users.noreply.github.com> Signed-off-by: suyao <sy20010504@gmail.com> Signed-off-by: kangfenmao <kangfenmao@qq.com> Signed-off-by: jdzhang <625013594@qq.com> Signed-off-by: jd <59188306+zhangjiadi225@users.noreply.github.com>
109 lines
6.6 KiB
Markdown
109 lines
6.6 KiB
Markdown
# Cherry Studio Documentation
|
|
|
|
## Guides
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [Development Setup](./guides/development.md) | Development environment setup |
|
|
| [Contributing](./guides/contributing.md) | How to contribute code |
|
|
| [Branching Strategy](./guides/branching-strategy.md) | Git branching workflow |
|
|
| [Test Plan](./guides/test-plan.md) | Test plan and release channels |
|
|
| [i18n Guide](./guides/i18n.md) | Internationalization guide |
|
|
| [Logging Guide](./guides/logging.md) | How to use the logger service |
|
|
| [Middleware](./guides/middleware.md) | How to write AI Provider middleware |
|
|
|
|
## References
|
|
|
|
### Architecture
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [Architecture Overview](./references/architecture-overview.md) | System-wide architecture, process model, data flow |
|
|
|
|
### AI Core
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [AI Reference](./references/ai/README.md) | Main-process AI pipeline: stream manager, agent loop, providers, tools |
|
|
| [Core Architecture](./references/ai/core-architecture.md) | End-to-end call flow from user input to LLM response |
|
|
| [Stream Manager](./references/ai/stream-manager.md) | Active-stream registry, broker, reconnect, persistence |
|
|
| [Adapter Family](./references/ai/adapter-family.md) | How endpoint → `@ai-sdk/*` package routing is decided |
|
|
|
|
### Data System
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [Data System Overview](./references/data/README.md) | System selection, architecture, and patterns |
|
|
| [Boot Config Overview](./references/data/boot-config-overview.md) | Early boot configuration system |
|
|
| [Boot Config Schema Guide](./references/data/boot-config-schema-guide.md) | Adding new boot config keys |
|
|
| [Cache Overview](./references/data/cache-overview.md) | Three-tier caching architecture and design invariants |
|
|
| [Cache Usage](./references/data/cache-usage.md) | useCache hooks, direct API, Main-process subscriptions |
|
|
| [Cache Schema Guide](./references/data/cache-schema-guide.md) | Adding new cache keys (fixed and template) |
|
|
| [Preference Overview](./references/data/preference-overview.md) | User settings management |
|
|
| [Preference Usage](./references/data/preference-usage.md) | usePreference hook examples |
|
|
| [Preference Schema Guide](./references/data/preference-schema-guide.md) | Adding new preference keys |
|
|
| [DataApi Overview](./references/data/data-api-overview.md) | Business data API architecture |
|
|
| [DataApi in Renderer](./references/data/data-api-in-renderer.md) | useQuery/useMutation patterns |
|
|
| [DataApi in Main](./references/data/data-api-in-main.md) | Handlers, Services, Repositories |
|
|
| [API Design Guidelines](./references/data/api-design-guidelines.md) | RESTful design rules |
|
|
| [API Types](./references/data/api-types.md) | API type system, schemas, error handling |
|
|
| [Database Patterns](./references/data/database-patterns.md) | DB naming, schema patterns |
|
|
| [Layered Preset Pattern](./references/data/best-practice-layered-preset-pattern.md) | Presets with user overrides |
|
|
| [V2 Migration Guide](./references/data/v2-migration-guide.md) | Migration system |
|
|
|
|
### Lifecycle System
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [Lifecycle Overview](./references/lifecycle/README.md) | Architecture, decision guides, usage |
|
|
| [Application Overview](./references/lifecycle/application-overview.md) | Application bootstrap and shutdown |
|
|
| [Lifecycle Internals](./references/lifecycle/lifecycle-overview.md) | Phases, hooks, states |
|
|
| [Lifecycle Usage](./references/lifecycle/lifecycle-usage.md) | Full usage guide with examples |
|
|
| [Lifecycle Decision Guide](./references/lifecycle/lifecycle-decision-guide.md) | Lifecycle vs singleton decision |
|
|
| [Lifecycle Migration Guide](./references/lifecycle/lifecycle-migration-guide.md) | Migrating old services |
|
|
|
|
### Messaging
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [Message System](./references/messaging/message-system.md) | Message lifecycle, state management, operations |
|
|
| [Composer Rich Clipboard](./references/messaging/composer-rich-clipboard.md) | Private composer token clipboard format and copy/paste flow |
|
|
| [Message Tree](./references/chat/message-tree.md) | Chat message-tree model: adjacency list, per-topic virtual root, sibling groups, invariants, delete semantics, getTree / flow-canvas contract |
|
|
| [Chat UI Design & Conventions](./references/chat/conventions.md) | How the chat UI is divided by responsibility (presentation / view-state / contracts / orchestration) and the conventions modules follow (context, refs, render stability) |
|
|
| [Chat Adapters](./references/chat/adapters.md) | The chat contract layer: projecting topics / sessions / messages into stable UI shapes, the pane / action registries, and render-stability rules |
|
|
|
|
### Knowledge
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [Knowledge Product Spec](./references/knowledge/experiment/knowledge-product-spec.md) | Condensed product semantics for Agent-managed knowledge bases (full version lives in Feishu) |
|
|
| [Knowledge Technical Design](./references/knowledge/experiment/knowledge-technical-design.md) | Condensed per-base index.sqlite schema, index store contracts, and retrieval decisions (full version lives in Feishu) |
|
|
| [KnowledgeService](./references/knowledge/knowledge-service.md) | Concurrency control and workload management |
|
|
| [Knowledge Operation Guards](./references/knowledge/operation-guards.md) | Guard, enqueue failure, and recovery semantics for add/delete/reindex |
|
|
|
|
### CherryClaw (Autonomous Agent)
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [CherryClaw Overview](./references/cherryclaw/overview.md) | Architecture, memory system, API |
|
|
| [Channel System](./references/cherryclaw/channels.md) | IM integration (Telegram, etc.) |
|
|
| [Claw MCP Server](./references/cherryclaw/mcp-claw.md) | Built-in MCP tools (cron, notify, skills, memory) |
|
|
| [Scheduler](./references/cherryclaw/scheduler.md) | Task-based polling scheduler |
|
|
|
|
### Components
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [CodeBlockView](./references/components/code-block-view.md) | Code block view component |
|
|
| [Image Preview](./references/components/image-preview.md) | Image preview components |
|
|
| [Code Execution](./references/components/code-execution.md) | Python code execution via Pyodide |
|
|
|
|
### Other
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [App Upgrade Config](./references/app-upgrade.md) | Application upgrade configuration |
|
|
| [Feishu Notify](./references/feishu-notify.md) | Feishu notification integration |
|
|
| [Fuzzy Search](./references/fuzzy-search.md) | Fuzzy search implementation |
|
|
| [LAN Transfer Protocol](./references/lan-transfer-protocol.md) | LAN file transfer protocol spec |
|