2026-05-04 03:40:08 +08:00
|
|
|
# scripts/ Agent 指南
|
|
|
|
|
|
|
|
|
|
本目录维护仓库级自动化脚本，主要用于 Markdown、链接、锚点、metadata 和 AI 引用资产校验。
|
|
|
|
|
|
|
|
|
|
## 约束
|
|
|
|
|
|
|
|
|
|
- 脚本默认从仓库根目录运行，路径解析必须稳定。
|
|
|
|
|
- 新增检查脚本时，同步更新 `scripts/README.md`、`Makefile`、CI 和根目录 `AGENTS.md` 的命令清单。
|
2026-05-04 05:07:59 +08:00
|
|
|
- `check-directory-docs.py` 对根 `.github/` 只要求 `AGENTS.md`，不要重新补 `.github/README.md`。
|
2026-05-04 03:47:52 +08:00
|
|
|
- 修改 docs 线性 README 的主章节或锚点后，优先运行 `python3 scripts/sync-doc-toc.py`，再运行 `make test`。
|
2026-05-04 03:40:08 +08:00
|
|
|
- 检查失败输出应包含文件路径、行号或可定位的错误信息。
|
|
|
|
|
- 跳过目录必须明确，至少跳过 `.git`、`.history`、`node_modules` 和外部源码快照。
|
|
|
|
|
|
|
|
|
|
## 验证
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
make test
|
|
|
|
|
```
|
