📝 docs(tsl): rebuild canonical syntax and routing manual
This commit is contained in:
+9
-7
@@ -84,7 +84,7 @@ docs/prompts/**/* # 项目新增的文件不会被删除
|
||||
### 参考资料(D类,不部署到项目根)
|
||||
|
||||
```
|
||||
# 留在 docs/standards/playbook/templates/ 中参考
|
||||
# 留在 <deploy_root>/templates/ 中参考
|
||||
ci/ # CI 配置
|
||||
cpp/ # C++ 配置
|
||||
python/ # Python 配置
|
||||
@@ -114,10 +114,12 @@ project_name = "MyProject"
|
||||
```
|
||||
|
||||
```bash
|
||||
python docs/standards/playbook/scripts/playbook.py -config playbook.toml
|
||||
python <deploy_root>/scripts/playbook.py -config playbook.toml
|
||||
```
|
||||
|
||||
参数说明见 `playbook.toml.example`(仓库根目录)或 vendoring 后的 `docs/standards/playbook/playbook.toml.example`。
|
||||
参数说明见 `playbook.toml.example`(仓库根目录)或项目内的 `<deploy_root>/playbook.toml.example`。
|
||||
|
||||
其中 `<deploy_root>` 默认为 `docs/standards/playbook`,也可以按项目配置改成 `custom/playbook` 等自定义目录;对应文档入口会变成 `<deploy_root>/docs/...`。
|
||||
|
||||
### 配置节说明
|
||||
|
||||
@@ -190,7 +192,7 @@ project/
|
||||
|
||||
`{{PROJECT_NAME}}` 可通过 `sync_memory_bank.project_name` 自动替换;未配置时保持原样。
|
||||
`{{MAIN_LANGUAGE}}` 可通过 `sync_standards.langs[0]` 自动替换;未配置时默认 `tsl`。
|
||||
`{{PLAYBOOK_SCRIPTS}}` 自动替换为 Playbook 脚本路径(默认 `docs/standards/playbook/scripts`)。
|
||||
`{{PLAYBOOK_SCRIPTS}}` 自动替换为 Playbook 脚本路径(默认 `docs/standards/playbook/scripts`,也可按项目配置改成 `custom/playbook/scripts` 等)。
|
||||
|
||||
## 模板说明
|
||||
|
||||
@@ -246,7 +248,7 @@ project/
|
||||
1) 先完成 brainstorming,并输出设计文档 `docs/plans/YYYY-MM-DD-<topic>-design.md`。
|
||||
2) 询问我“是否进入 `docs/plans/` 实施计划编写阶段”,确认后使用 writing-plans 生成实现计划。
|
||||
3) 实现计划内明确标注每步要改的文件与命令;验证步骤只包含可通过的局部验证,不包含测试。
|
||||
4) 执行计划时只走主循环,并通过 `docs/standards/playbook/scripts/main_loop.py claim/finish` 更新 `memory-bank/progress.md`。
|
||||
4) 执行计划时只走主循环,并通过 `<deploy_root>/scripts/main_loop.py claim/finish` 更新 `memory-bank/progress.md`。
|
||||
```
|
||||
|
||||
### AGENTS.template.md
|
||||
@@ -291,7 +293,7 @@ langs = ["tsl", "cpp", "python"]
|
||||
|
||||
```bash
|
||||
python scripts/playbook.py -config playbook.toml
|
||||
# 然后手动从 docs/standards/playbook/templates/ 复制所需配置到项目根目录
|
||||
# 然后手动从 <deploy_root>/templates/ 复制所需配置到项目根目录
|
||||
```
|
||||
|
||||
## 与 playbook 其他部分的关系
|
||||
@@ -311,7 +313,7 @@ playbook/
|
||||
|
||||
```bash
|
||||
# 1. 准备配置并执行统一入口
|
||||
python docs/standards/playbook/scripts/playbook.py -config playbook.toml
|
||||
python <deploy_root>/scripts/playbook.py -config playbook.toml
|
||||
|
||||
# 2. 编辑 memory-bank/*.md 填写项目信息
|
||||
|
||||
|
||||
Reference in New Issue
Block a user