Northern_Lights/cherry-studio
1
0
Fork 0
mirror of https://github.com/CherryHQ/cherry-studio.git synced 2025-12-31 16:49:07 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
b156ee68e0
cherry-studio/docs
History
fullex b156ee68e0 feat(cache): enhance shared cache functionality and synchronization in main 
- Introduced type-safe access methods for shared cache in the Main process, including `getShared`, `setShared`, `hasShared`, and `deleteShared`.
- Implemented `getAllShared` for initializing new Renderer windows with the complete shared cache state.
- Updated IPC communication to support bidirectional synchronization of shared cache between Main and Renderer processes.
- Enhanced cache management with absolute timestamps for TTL, ensuring precise expiration handling across windows.
- Added ready state tracking in Renderer for improved synchronization feedback during initialization.
- Refactored related documentation to reflect new features and usage patterns for shared cache.
2025-12-29 23:56:27 +08:00
..
assets/images docs: update docs directory structure 2025-11-26 13:17:01 +08:00
en feat(cache): enhance shared cache functionality and synchronization in main 2025-12-29 23:56:27 +08:00
zh docs: fix copy -> cp in development guide (#12142) 2025-12-26 17:05:45 +08:00
README.md docs: update docs directory structure 2025-11-26 13:17:01 +08:00

README.md

Cherry Studio Documentation / 文档

This directory contains the project documentation in multiple languages.

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

Languages / 语言

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

English Documentation

Guides

Document Description
Development Setup Development environment setup
Branching Strategy Git branching workflow
i18n Guide Internationalization guide
Logging Guide How to use the logger service
Test Plan Test plan and release channels

References

Document Description
App Upgrade Config Application upgrade configuration
CodeBlockView Component Code block view component
Image Preview Components Image 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