Northern_Lights/cherry-studio
1
0
Fork 0
mirror of https://github.com/CherryHQ/cherry-studio.git synced 2026-01-10 07:19:02 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
61aae7376a
cherry-studio/docs
History
Phantom 43a48a4a38
feat(scripts): migrate feishu-notify to TypeScript CLI tool with subcommands (#12371) 
* build: add commander package as dependency

* refactor(scripts): migrate feishu-notify to TypeScript with CLI interface

- Convert JavaScript implementation to TypeScript with proper type definitions
- Add CLI interface using commander for better usability
- Improve error handling and input validation
- Add version management and subcommand support

* ci(workflows): update feishu notification command and add pnpm install step

Update the feishu notification command to use CLI tool with proper arguments instead of direct node script execution
Add pnpm install step to ensure dependencies are available before running the workflow

* docs: add feishu notification script documentation

Add Chinese and English documentation for the feishu-notify.ts CLI tool

* feat(notify): add generic send command to feishu-notify

Add a new 'send' subcommand to send simple notifications to Feishu with customizable title, description and header color. This provides a more flexible way to send notifications without being tied to specific business logic like the existing 'issue' command.

The implementation includes:
- New send command handler and options interface
- Simple card creation function
- Zod schema for header color validation
- Documentation updates in both Chinese and English
2026-01-08 16:55:46 +08:00
..
assets/images docs: update docs directory structure 2025-11-26 13:17:01 +08:00
en feat(scripts): migrate feishu-notify to TypeScript CLI tool with subcommands (#12371) 2026-01-08 16:55:46 +08:00
zh feat(scripts): migrate feishu-notify to TypeScript CLI tool with subcommands (#12371) 2026-01-08 16:55:46 +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