Files
tradecatlabs a8099f52fe docs: add research domains and resource registry
- add local external resources registry
- add research domain contract and per-repository research domains
- add raw fact snapshot governance and validation scripts

Validation:
- make test
- git diff --check HEAD~1..HEAD

Note:
- welcome workflow failed because its action input names are stale; core content CI passed.
2026-07-03 08:20:22 +08:00

1.3 KiB

scripts/ Agent 指南

本目录维护仓库级自动化脚本,主要用于 Markdown、链接、锚点、metadata、AI 引用资产、外部资源注册表校验、研究域 raw 原始事实层与 Git 工作树检查和拉取。

约束

  • 脚本默认从仓库根目录运行,路径解析必须稳定。
  • 新增检查脚本时,同步更新 scripts/README.mdMakefile 和根目录 AGENTS.md 的命令清单;只有 CI 环境稳定具备所需输入时才纳入 CI。
  • fetch-research-raw.py 访问 GitHub 网络 API,只作为手动刷新命令,不纳入 make test 或 CI 硬门禁。
  • check-research-raw.py 只检查本地文件结构和 JSON 形态,可以纳入 make test
  • check-directory-docs.py 对根 .github/ 只要求 AGENTS.md,不要重新补 .github/README.md
  • 修改 docs README 或主题正文的主章节、锚点、索引后,优先运行 python3 scripts/sync-doc-toc.py,再运行 make test
  • 修改 GitHub Wiki 独立仓库后,运行 make check-wiki WIKI_DIR=/path/to/wiki;不要把 Wiki checkout 提交进主仓。
  • 检查失败输出应包含文件路径、行号或可定位的错误信息。
  • 跳过目录必须明确,至少跳过 .git.historybuildnode_modules 和外部源码快照。

验证

make test