docs: clarify asset sync workflow (#443)

Replace stale symlink instructions with the current real-file mirror and validated sync workflow.
This commit is contained in:
Viet Tran 2026-08-12 17:20:38 +07:00 committed by GitHub
parent 7c1806cc0a
commit 97eb2a2003
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -5,26 +5,27 @@
| 位置 | 作用 | 能删吗 |
|------|------|--------|
| **src/ui-ux-pro-max/** | **唯一源码**。所有 CSV、脚本、模板都在这里改是“唯一真相来源”。 | ❌ 不能删,这是你要维护的那一份。 |
| **.claude/skills/ui-ux-pro-max/** | 给 **Cursor / Claude Code** 用的 Skill。AI 从这里读 SKILL.md 和运行 `scripts/search.py`。设计上这里的 data、scripts 应是**指向 src 的符号链接**,这样不用维护两份。 | ❌ 不能删(否则 Skill 不工作);但可以改成只链到 src不保留副本。 |
| **cli/assets/** | 给 **npm 包 ui-ux-pro-max-cli** 打包用。用户执行 `npm i -g ui-ux-pro-max-cli``uipro init` 时,安装的是这里打包进去的 data/scripts/templates。 | ❌ 不能删;发布前用脚本从 src 同步过来即可。 |
| **.claude/skills/ui-ux-pro-max/** | 给 **Claude Code** 使用的 Skill。`SKILL.md` 手工维护;`data/``scripts/` 是从 `src` 同步的真实文件副本。 | ❌ 不能删,也不要改成符号链接;符号链接会在 Windows 的 Git 检出中失效。 |
| **cli/assets/** | 给 **npm 包 ui-ux-pro-max-cli** 打包用。用户执行 `npm i -g ui-ux-pro-max-cli``uipro init` 时,安装的是这里打包的 data/scripts/templates 和子 Skill。 | ❌ 不能删;发布前用脚本同步。 |
## 可以只保留一个吗?
- **不能**只保留一个“物理目录”:三处**用途不同**,都要存在。
- **可以**只维护**一份内容**
- 所有修改只在 **src/ui-ux-pro-max/** 里做。
- .claude 里用**符号链接**指向 src → 不用在 .claude 里再维护 data/scripts。
- 发布 CLI 前执行一次同步:把 src 拷到 cli/assets。
- **只手工维护一份内容**:在 **src/ui-ux-pro-max/** 修改 data、scripts 和 templates再用 `cli/scripts/sync-assets.mjs` 将它们复制到 `cli/assets/`,并将 data、scripts 复制到本地 Claude Skill 目录。
- `.claude/skills/ui-ux-pro-max/SKILL.md` 是例外:它不由模板生成,需要直接维护。
这样你日常只改 src其它两处自动或按需跟上
这样 data、scripts 和 templates 只在 `src` 维护,镜像目录由同步脚本更新。
## 推荐工作流
1. 只改 **src/ui-ux-pro-max/data/**、**scripts/**、**templates/**。
2. .claude/skills 下的 data、scripts 用 symlink 指回 src见下方「恢复符号链接」
3. 发布 npm 前执行:
2. 不要直接修改 `cli/assets/data/``cli/assets/scripts/``.claude/skills/ui-ux-pro-max/{data,scripts}/`
3. 提交或发布 npm 前执行:
```bash
cd cli
npm run sync:assets
npm run check:assets
```
`check:assets` 也由 “Check asset sync” CI 工作流执行。