📝 docs: add claude_md config and use cross-platform paths
- Add claude_md option to playbook.toml.example with auto-detection docs - Replace Windows-only C:/tools/playbook paths with /opt/playbook in README Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
d64b248adf
commit
2431c9d3ad
|
|
@ -199,7 +199,7 @@ TSL 相关问题直接查阅 `rulesets/tsl/index.md` 与 `docs/tsl/`。
|
|||
|
||||
- `project_root`:目标项目根目录。
|
||||
- `deploy_root`:相对于 `project_root` 的项目内目标目录。
|
||||
- 外部 clone 出来的 Playbook 路径,例如 `C:/tools/playbook`:只是执行部署脚本的位置,不是外部 clone 出来的 Playbook 仓库路径对应的部署目标。
|
||||
- 外部 clone 出来的 Playbook 路径(如 `/opt/playbook` 或 `C:/tools/playbook`):只是执行部署脚本的位置,不是部署目标。
|
||||
|
||||
以 TSL 为例,Playbook 在项目内的默认部署根是 `docs/standards/playbook`;如果你把 `deploy_root` 改成 `custom/playbook`,则部署结果会落到 `<project_root>/custom/playbook`,文档和脚本入口也会跟着变成 `custom/playbook/docs/...`、`custom/playbook/scripts/...`。
|
||||
|
||||
|
|
@ -273,14 +273,14 @@ git commit -m ":package: deps(playbook): add tsl standards"
|
|||
1. 先在任意位置 clone Playbook:
|
||||
|
||||
```bash
|
||||
git clone https://git.mytsl.cn/csh/playbook.git C:/tools/playbook
|
||||
git clone https://git.mytsl.cn/csh/playbook.git /opt/playbook
|
||||
```
|
||||
|
||||
2. 在目标项目根创建 `playbook.toml`,并用 `deploy_root` 指定项目内的部署根。例如:
|
||||
|
||||
- `project_root` 写目标项目根目录。
|
||||
- `deploy_root` 写目标项目内的相对路径。
|
||||
- 不要把外部 clone 的 `C:/tools/playbook` 这类路径写进 `deploy_root`;那只是你执行脚本的位置。
|
||||
- 不要把外部 clone 的路径(如 `/opt/playbook`)写进 `deploy_root`;那只是你执行脚本的位置。
|
||||
|
||||
```toml
|
||||
[playbook]
|
||||
|
|
@ -302,7 +302,7 @@ git commit -m ":package: deps(playbook): add tsl standards"
|
|||
3. 在目标项目根执行外部 clone 里的统一入口:
|
||||
|
||||
```bash
|
||||
python C:/tools/playbook/scripts/playbook.py -config playbook.toml
|
||||
python /opt/playbook/scripts/playbook.py -config playbook.toml
|
||||
```
|
||||
|
||||
说明:
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@
|
|||
[playbook]
|
||||
# project_root = "." # 可选:目标项目根目录
|
||||
# deploy_root = "docs/standards/playbook" # 项目内已部署时可省略;从外部 clone 执行时必填;值始终是相对于 project_root 的项目内路径,不是外部 clone 的 playbook 路径
|
||||
# claude_md = "CLAUDE.md" # 可选:CLAUDE.md 位置(默认自动检测:根目录 → .claude/CLAUDE.md → 自动创建)
|
||||
|
||||
[vendor]
|
||||
# 当从外部 clone 的 playbook 向项目内部署快照时启用
|
||||
|
|
|
|||
Loading…
Reference in New Issue