docs: add directory governance docs

This commit is contained in:
tukuaiai
2026-05-04 03:40:08 +08:00
parent f1d6a8980a
commit 4492674a41
21 changed files with 273 additions and 6 deletions
+17
View File
@@ -0,0 +1,17 @@
# metadata/ Agent 指南
本目录维护机器可读索引,是 README、docs 和 AI 引用资产之间的结构桥。
## 约束
- 新增、删除、移动或重命名 docs 入口时,必须同步 `taxonomy.yml`
- 历史路径仍需被 AI 或外部说明理解时,维护 `redirects.yml`
- 术语口径变化时,同步 `glossary.yml`
- 不确定的映射不要猜;先查当前文件和锚点,再修改。
## 验证
```bash
make check-metadata
make test
```
+18
View File
@@ -0,0 +1,18 @@
# metadata
本目录存放机器可读索引,用于约束文档结构、AI 引用入口和历史路径映射。
## 文件
- `taxonomy.yml`:知识库分类、阅读路径和关键文档入口。
- `glossary.yml`:项目术语表。
- `redirects.yml`:历史路径到当前入口的映射,供维护和 AI 上下文使用。
## 使用
修改目录、锚点、阅读路径或关键入口后,必须同步更新本目录,并运行:
```bash
make check-metadata
make test
```