mirror of https://github.com/CherryHQ/cherry-studio.git synced 2026-07-06 22:55:56 +08:00

Files

Phantom fe0678a206 chore: migrate .claude/skills to directory symlinks (#13486 )

### What this PR does

Before this PR:

`.claude/skills/<name>/SKILL.md` files were **copied** from
`.agents/skills/<name>/SKILL.md` via `pnpm skills:sync`. A dedicated
`skills-check-windows` CI job ran on `windows-latest` to verify
cross-platform file-copy compatibility.

After this PR:

`.claude/skills/<name>` entries are **directory symlinks** pointing to
`../../.agents/skills/<name>`, following the Single Source of Truth
(SSoT) principle. The Windows-specific CI job is removed; Windows
developers are expected to enable symlink support.

### Why we need it and why it was done in this way

The following tradeoffs were made:

- Windows developers must now manually enable symlink support (Developer
Mode + `git config --global core.symlinks true`). This is acceptable
because:
1. The existing `AGENTS.md` is already a symlink, so Windows
compatibility was never fully enforced.
2. Symlinks eliminate the need for file-copy synchronization, reducing
maintenance complexity.
3. Contributors are expected to have sufficient technical capability to
configure their environments.

The following alternatives were considered:

- Keeping file-copy sync: rejected because it duplicates content and
requires extra CI to verify consistency.

### Breaking changes

Windows developers who clone without symlink support enabled will get
plain text files instead of symlinks. They must:
1. Enable Developer Mode or grant `SeCreateSymbolicLinkPrivilege`
2. Run `git config --global core.symlinks true`
3. Re-clone or run `pnpm skills:sync`

### Special notes for your reviewer

- The `.github/workflows/ci.yml` diff includes minor quote-style changes
(`'` → `"`) from the YAML formatter — these are cosmetic only.

### Checklist

- [x] PR: The PR description is expressive enough and will help future
contributors
- [x] Code: [Write code that humans can
understand](https://en.wikiquote.org/wiki/Martin_Fowler#code-for-humans)
and [Keep it simple](https://en.wikipedia.org/wiki/KISS_principle)
- [x] Refactor: You have [left the code cleaner than you found it (Boy
Scout
Rule)](https://learning.oreilly.com/library/view/97-things-every/9780596809515/ch08.html)
- [x] Upgrade: Impact of this change on upgrade flows was considered and
addressed if required
- [x] Documentation: A [user-guide update](https://docs.cherry-ai.com)
was considered and is present (link) or not required. Check this only
when the PR introduces or changes a user-facing feature or behavior.
- [ ] Self-review: I have reviewed my own code (e.g., via
[`/gh-pr-review`](/.claude/skills/gh-pr-review/SKILL.md), `gh pr diff`,
or GitHub UI) before requesting review from others

### Release note

```release-note
NONE
```

Signed-off-by: icarus <eurfelux@gmail.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

2026-03-16 08:46:46 +08:00

assets/images

docs: update docs directory structure

2025-11-26 13:17:01 +08:00

chore: migrate .claude/skills to directory symlinks (#13486 )

2026-03-16 08:46:46 +08:00

chore: migrate .claude/skills to directory symlinks (#13486 )

2026-03-16 08:46: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