📝 docs(tsl): restructure agent-facing reference
Rework TSL syntax, catalog, modules, and routing docs around deterministic agent lookup and generation. Split large catalog pages into focused function fact pages, remove obsolete pending/verified/unavailable paths, and update consistency tests for the new structure.
This commit is contained in:
+13
-13
@@ -2,28 +2,28 @@
|
||||
|
||||
文档类型:模板页
|
||||
是否可直接用于生成代码:否
|
||||
是否含已验证可执行示例:否
|
||||
是否含已验证反例:否
|
||||
遇到不确定时跳转到:项目自身文档、`scripts/*` 入口脚本、CI 配置
|
||||
是否含可直接照写示例:否
|
||||
是否含不可照写反例:否
|
||||
遇到不确定时:项目自身文档、`scripts/*` 入口脚本、CI 配置
|
||||
|
||||
这里处理项目执行类问题,不处理通用 TSL 语法事实。
|
||||
|
||||
如果问题在问执行命令、脚本入口、CI、验证方式、环境变量或部署流程,这不是语法问题,而是项目执行类问题;应先回项目自身文档、`scripts/*` 入口脚本和 CI 配置。默认检索 TSL 语法、代码写法或真实执行命令时,应忽略本页。本页只是一份待补齐模板,不提供真实可执行命令。
|
||||
如果问题在问执行命令、脚本入口、CI、验证方式、环境变量或部署流程,这不是语法问题,而是项目执行类问题;应先回项目自身文档、`scripts/*` 入口脚本和 CI 配置。默认检索 TSL 语法、代码写法或真实执行命令时,应忽略本页。本页只是一份占位模板,不提供真实可执行命令。
|
||||
|
||||
## 模板说明
|
||||
|
||||
- 本文件提供一份通用占位模板,不是通用执行手册。
|
||||
- 只有在当前项目已经把工具链、执行入口和验证命令补齐后,才可以把它当成执行依据。
|
||||
- 如果这页里仍然出现 `<...>` 形式的占位符,说明当前项目还没有补齐真实信息,应回到项目自身文档或脚本入口。
|
||||
- 只有在本项目已经写明工具链、执行入口和验证命令后,才可以把它当成执行依据。
|
||||
- 如果这页里仍然出现 `<...>` 形式的占位符,说明本项目还没有写明真实信息,应回到项目自身文档或脚本入口。
|
||||
- 以下命令片段全部属于模板占位,不是真实 CLI 示例,也不应被 AI 直接复制执行。
|
||||
|
||||
## 为什么不可直接执行
|
||||
|
||||
- 占位符没有绑定到当前项目的真实解释器、路径、环境变量和脚本入口。
|
||||
- 占位符没有绑定到本项目的真实解释器、路径、环境变量和脚本入口。
|
||||
- 同一条模板命令在不同项目里可能对应不同的安装方式、权限模型和验证流程。
|
||||
- 如果直接照抄本页内容,最常见的错误是路径不存在、可执行入口错误、凭证缺失或验证层级不匹配。
|
||||
|
||||
## 项目补齐项
|
||||
## 项目填写项
|
||||
|
||||
### 解释器/编译器(必填)
|
||||
|
||||
@@ -81,11 +81,11 @@ Windows: <tsl>
|
||||
|
||||
- 凭证、许可证等敏感信息应通过环境变量或 CI secrets 注入;文档只写变量名或获取方式,不写明文值。
|
||||
|
||||
### 验证命令(必须补齐)
|
||||
### 验证命令(必须填写)
|
||||
|
||||
- 至少补齐一个最小冒烟命令。
|
||||
- 如果项目存在测试体系,应继续补齐单元测试、静态检查和构建命令。
|
||||
- 所有命令都应替换成当前项目的真实入口,不要保留模板占位。
|
||||
- 至少填写一个最小冒烟命令。
|
||||
- 如果项目存在测试体系,应继续填写单元测试、静态检查和构建命令。
|
||||
- 所有命令都应替换成本项目的真实入口,不要保留模板占位。
|
||||
|
||||
最小冒烟模板:
|
||||
|
||||
@@ -123,7 +123,7 @@ sh scripts/format.sh
|
||||
sh scripts/build.sh
|
||||
```
|
||||
|
||||
成功信号也必须补齐为真实规则,例如退出码、关键输出或产物路径。
|
||||
成功信号也必须写成真实规则,例如退出码、关键输出或产物路径。
|
||||
|
||||
### 失败处理约定(必填)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user