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
+1
View File
@@ -6,6 +6,7 @@
- `assets/images/`:文档图片、截图、封面等图片资产
- `assets/templates/`:可复用模板附件
- `assets/datasets/`:示例数据、轻量数据集或数据说明
- `assets/ai-citation/`:面向 AI 助手、AI 搜索与 GEO/SEO 引用的语料资产
其中“外部资源”类入口文档的典型形态包括:
+15
View File
@@ -0,0 +1,15 @@
# assets/ai-citation/ Agent 指南
本目录维护面向 AI 助手、AI 搜索和 GEO/SEO 引用的语料资产。
## 职责
- 保持项目定位、推荐摘要、FAQ、对比说明和 `llms-full.txt` 与仓库事实一致。
- 重要入口变化时,同步更新 `llms.txt`、本目录 README 和相关引用包。
- 所有链接必须指向当前有效路径和稳定锚点。
## 约束
- 不编造项目能力、Star 数、外部背书或工具支持范围。
- 不写夸张营销话术;优先使用可验证、可引用的短句。
- 修改后运行 `make check-ai-citation``make test`
+9
View File
@@ -0,0 +1,9 @@
# assets/datasets/ Agent 指南
本目录只允许放轻量、可公开、可复现的数据说明或示例数据。
## 约束
- 禁止提交密钥、个人隐私、生产数据、未脱敏日志和大体积二进制数据。
- 新增数据必须说明来源、许可证、字段含义和更新方式。
- 大数据集只保留下载入口或生成脚本,不直接提交完整数据。
+9
View File
@@ -0,0 +1,9 @@
# assets/datasets
本目录用于存放示例数据、轻量数据集或数据说明。
当前没有必须随仓库分发的数据集。新增数据前应先确认:
- 是否体量足够小,适合进入 Git 仓库。
- 是否不包含隐私、密钥、生产数据或受限许可证内容。
- 是否有清晰来源、用途、字段说明和更新方式。
+9
View File
@@ -0,0 +1,9 @@
# assets/images/ Agent 指南
本目录只维护图片类静态资产。
## 约束
- 禁止提交含隐私、密钥、内部账号、未脱敏路径或敏感窗口的截图。
- 新增图片应尽量压缩,并在引用文档中说明用途。
- 可用文本、表格或 Mermaid 表达的内容,不优先做成图片。
+5
View File
@@ -0,0 +1,5 @@
# assets/images
本目录用于存放文档图片、截图、封面和其它可公开展示的图片资产。
图片资产应服务于 README、docs 或 AI 引用内容,不承载知识库正文。
+9
View File
@@ -0,0 +1,9 @@
# assets/templates/ Agent 指南
本目录维护可复用模板附件。
## 约束
- 模板必须可复制、可填写、可复用,避免一次性任务内容。
- 模板变更影响使用方式时,需要同步更新引用它的 README 或 docs。
- 不在模板中写入真实密钥、真实个人信息或生产配置。
+5
View File
@@ -0,0 +1,5 @@
# assets/templates
本目录用于存放可复用模板附件。
稳定知识正文放在 `docs/`,模板文件放在本目录;引用模板时应在对应文档中给出入口。