Northern_Lights/cherry-studio
1
0
Fork 0
mirror of https://github.com/CherryHQ/cherry-studio.git synced 2026-01-11 16:39:15 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity
fb51df99d0
cherry-studio/docs
History
fullex fb51df99d0 feat(cache): add template key support for useCache with type inference 
- Add type utilities for template key matching (IsTemplateKey, ExpandTemplateKey, ProcessKey)
- Add InferUseCacheValue<K> for automatic value type inference from template patterns
- Update useCache hook to support template keys with default value fallback
- Extend ESLint rule to validate template key syntax (e.g., 'scroll.position:${id}')
- Update CacheService.get() docs: clarify | undefined return is intentional
  (developers need to know when value doesn't exist after deletion/TTL expiry)
- Update cache documentation with template key usage examples

BREAKING CHANGE: CacheService.get() now explicitly returns T | undefined
(was implicit before). Callers should use ?? defaultValue for fallback.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-05 12:23:19 +08:00
..
assets/images docs: update docs directory structure 2025-11-26 13:17:01 +08:00
en feat(cache): add template key support for useCache with type inference 2026-01-05 12:23:19 +08:00
zh fix: update links in README and AboutSettings for correct documentation paths 2026-01-04 16:07:56 +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