Back to Cherry Studio

Cherry Studio Documentation / 文档

docs/README.md

1.9.42.8 KB
Original Source

Cherry Studio Documentation / 文档

This directory contains the project documentation in multiple languages.

本目录包含多语言项目文档。


Languages / 语言

  • 中文文档 - Chinese Documentation
  • English Documentation - See sections below

English Documentation

Guides

DocumentDescription
Development SetupDevelopment environment setup
Branching StrategyGit branching workflow
i18n GuideInternationalization guide
Logging GuideHow to use the logger service
Test PlanTest plan and release channels

References

DocumentDescription
App Upgrade ConfigApplication upgrade configuration
CodeBlockView ComponentCode block view component
Image Preview ComponentsImage preview components

中文文档

指南 (Guides)

文档说明
开发环境设置开发环境配置
贡献指南如何贡献代码
分支策略Git 分支工作流
测试计划测试计划和发布通道
国际化指南国际化开发指南
日志使用指南如何使用日志服务
中间件开发如何编写中间件
记忆功能记忆功能使用指南
赞助信息赞助相关信息

参考 (References)

文档说明
消息系统消息系统架构和 API
数据库结构数据库表结构
服务服务层文档 (KnowledgeService)
代码执行代码执行功能
应用升级配置应用升级配置
CodeBlockView 组件代码块视图组件
图像预览组件图像预览组件

Missing Translations / 缺少翻译

The following documents are only available in Chinese and need English translations:

以下文档仅有中文版本,需要英文翻译:

  • guides/contributing.md
  • guides/memory.md
  • guides/middleware.md
  • guides/sponsor.md
  • references/message-system.md
  • references/database.md
  • references/services.md
  • references/code-execution.md