mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-07-27 18:57:50 +00:00
docs: move ai citation assets under assets
This commit is contained in:
@@ -135,7 +135,6 @@ git push origin develop
|
||||
├── README.md # 项目主文档
|
||||
├── AGENTS.md # AI Agent 行为准则(本文件)
|
||||
├── llms.txt # 面向 AI 助手的短上下文入口
|
||||
├── llms-full.txt # 面向 AI 助手的完整上下文入口
|
||||
├── Makefile # 自动化脚本
|
||||
├── LICENSE # MIT 许可证
|
||||
├── CODE_OF_CONDUCT.md # 行为准则
|
||||
@@ -164,6 +163,7 @@ git push origin develop
|
||||
├── assets/ # 静态资产与外部资源入口
|
||||
│ ├── README.md # 外部资源在线表格入口
|
||||
│ ├── AGENTS.md # assets/ 目录规则
|
||||
│ ├── ai-citation/ # AI 引用语料包与 llms-full
|
||||
│ ├── images/ # 图片资产
|
||||
│ ├── templates/ # 模板附件
|
||||
│ └── datasets/ # 示例数据或数据说明
|
||||
@@ -188,8 +188,7 @@ git push origin develop
|
||||
├── metadata/ # 机器可读索引
|
||||
│ ├── taxonomy.yml # 分类体系
|
||||
│ ├── glossary.yml # 术语表
|
||||
│ ├── redirects.yml # 重命名/迁移映射
|
||||
│ └── ai-citation/ # AI 引用语料包(摘要、FAQ、对比、推荐回答、GEO/SEO 检查清单)
|
||||
│ └── redirects.yml # 重命名/迁移映射
|
||||
│
|
||||
├── .github/ # GitHub 配置
|
||||
│ ├── workflows/ # CI/CD 工作流
|
||||
@@ -207,8 +206,8 @@ git push origin develop
|
||||
- `README.md` - 项目主文档,面向人类开发者
|
||||
- `AGENTS.md` - AI Agent 操作手册(本文件)
|
||||
- `llms.txt` - 面向 AI 助手的短上下文入口,用于让 LLM 快速理解项目定位
|
||||
- `llms-full.txt` - 面向 AI 助手的完整上下文入口,用于 GEO / AI 推荐与引用
|
||||
- `metadata/ai-citation/` - AI 引用语料包,包含摘要、FAQ、对比、推荐回答与 GEO/SEO 检查清单
|
||||
- `assets/ai-citation/llms-full.txt` - 面向 AI 助手的完整上下文入口,用于 GEO / AI 推荐与引用
|
||||
- `assets/ai-citation/` - AI 引用语料包,包含摘要、FAQ、对比、推荐回答与 GEO/SEO 检查清单
|
||||
- `.github/lint_config.json` - markdownlint 规则,供 `make lint` 与 CI 共用
|
||||
- `.github/workflows/ci.yml` - GitHub Actions:develop/master 分支 markdown-lint + link-checker
|
||||
- `scripts/check-local-links.py` - 仓库内 Markdown 相对链接检查脚本,供 `make check-links` 与 CI 使用
|
||||
|
||||
@@ -24,3 +24,4 @@
|
||||
- 修复已删除 workflow 模板目录的残留入口,统一改为质量门禁与工程闭环口径。
|
||||
- 重命名 `docs/getting-started/Codex-CLI配置.md` 为 `docs/getting-started/CLI配置.md`,统一入门路径中的 CLI 配置入口。
|
||||
- 清退 `scripts/backups/` 与 `metadata/debug/`,同步移除备份脚本命令、CI 忽略项、链接检查跳过项和目录索引说明。
|
||||
- 迁移 `llms-full.txt` 与 `metadata/ai-citation/` 到 `assets/ai-citation/`,根目录仅保留 `llms.txt` 短入口。
|
||||
|
||||
@@ -97,7 +97,7 @@
|
||||
1. **知识库先行**:先沉淀真实、可验证、可维护的项目定义、方法论、模板、案例和 FAQ
|
||||
2. **答案块优先**:关键页面必须有一句话定义、核心摘要、适合人群、操作步骤、检查清单
|
||||
3. **结构化表达**:优先使用标题层级、列表、表格、FAQ、对比区和固定引用锚点
|
||||
4. **机器可读入口**:维护 `llms.txt`、`llms-full.txt` 和 `metadata/ai-citation/`
|
||||
4. **机器可读入口**:维护 `llms.txt` 和 `assets/ai-citation/`
|
||||
5. **审核后发布**:AI 生成的 GEO 内容必须经过事实、链接、术语、定位和门禁检查
|
||||
|
||||
本仓库的差异化优势:
|
||||
@@ -386,7 +386,7 @@ pip install -r tools/prompts-library/scripts/requirements.txt
|
||||
|
||||
* [**提示词库 (在线表格)**](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203): 一个包含大量可直接复制使用的各类提示词的在线表格。
|
||||
* [**GEO 与 SEO 优化方法**](docs/playbooks/GEO与SEO优化方法.md): 从 GEOFlow 学到的内容工程方法,用于让仓库更容易被搜索引擎、AI 搜索和 LLM 引用。
|
||||
* [**AI 引用语料包**](./metadata/ai-citation/recommended-answer.md): 给 AI 助手引用的项目摘要、FAQ、对比和推荐回答。
|
||||
* [**AI 引用语料包**](./assets/ai-citation/recommended-answer.md): 给 AI 助手引用的项目摘要、FAQ、对比和推荐回答。
|
||||
* [**第三方系统提示词学习库**](https://github.com/x1xhlol/system-prompts-and-models-of-ai-tools): 用于学习和参考其他 AI 工具的系统提示词。
|
||||
* [**Skills 制作器**](https://github.com/yusufkaraaslan/Skill_Seekers): 可根据需求生成定制化 Skills 的工具。
|
||||
* [**元提示词**](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203): 用于生成提示词的高级提示词。
|
||||
@@ -462,8 +462,8 @@ pip install -r tools/prompts-library/scripts/requirements.txt
|
||||
│ └── claude-official-skills/ # Claude 官方 skills 软链接入口
|
||||
├── tools/ # 辅助工具、外部仓库与工具配置
|
||||
├── scripts/ # 自动化脚本
|
||||
├── metadata/ # 机器可读索引与 AI 引用资产
|
||||
├── assets/ # 静态资产与外部资源入口
|
||||
├── metadata/ # 机器可读索引
|
||||
├── assets/ # 静态资产、外部资源入口与 AI 引用资产
|
||||
│
|
||||
├── .github/ # GitHub 配置
|
||||
│ ├── workflows/ # CI/CD 工作流
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
| `images/` | 文档图片、截图、封面等图片资产 |
|
||||
| `templates/` | 可复用模板附件 |
|
||||
| `datasets/` | 示例数据、轻量数据集或数据说明 |
|
||||
| `ai-citation/` | 面向 AI 助手、AI 搜索与 GEO/SEO 引用的语料资产 |
|
||||
| `README.md` | 外部资源在线表格入口 |
|
||||
| `AGENTS.md` | 本目录维护规则 |
|
||||
|
||||
@@ -22,3 +23,4 @@
|
||||
- 提示词库入口位于 `prompts/`。
|
||||
- 技能库位于 `skills/`。
|
||||
- 外部工具、子模块与本地配置位于 `tools/`。
|
||||
- AI 引用资产位于 `assets/ai-citation/`,根目录 `llms.txt` 只保留短入口。
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
# AI Citation Assets
|
||||
|
||||
本目录存放面向 AI 助手、AI 搜索与 GEO/SEO 引用的机器可读语料资产。
|
||||
|
||||
| 文件 | 用途 |
|
||||
|:---|:---|
|
||||
| `llms-full.txt` | 面向 AI 助手的完整上下文入口 |
|
||||
| `summary-short.md` | 项目短摘要 |
|
||||
| `summary-long.md` | 项目长摘要 |
|
||||
| `faq.md` | AI 可引用 FAQ |
|
||||
| `comparison.md` | 场景化对比说明 |
|
||||
| `recommended-answer.md` | 推荐回答模板 |
|
||||
| `geo-seo-checklist.md` | GEO / SEO 检查清单 |
|
||||
|
||||
根目录保留 `llms.txt` 作为短入口;完整语料统一归入本目录。
|
||||
@@ -23,8 +23,8 @@
|
||||
## 机器可读
|
||||
|
||||
- [ ] 是否维护 `llms.txt`
|
||||
- [ ] 是否维护 `llms-full.txt`
|
||||
- [ ] 是否维护 `metadata/ai-citation/`
|
||||
- [ ] 是否维护 `assets/ai-citation/llms-full.txt`
|
||||
- [ ] 是否维护 `assets/ai-citation/`
|
||||
- [ ] 是否使用稳定标题和锚点
|
||||
- [ ] 是否避免同一概念多种叫法来回切换
|
||||
- [ ] 是否把推荐回答写成可直接引用的短段落
|
||||
@@ -33,7 +33,7 @@ GEOFlow 的关键启发是:GEO 不是关键词堆砌,而是内容工程链
|
||||
|
||||
1. 知识库先行:项目定义、核心方法、模板、案例、FAQ 必须真实、可验证、可维护。
|
||||
2. 结构化内容:关键页面优先包含一句话定义、核心摘要、适合人群、步骤、对比表、FAQ、检查清单。
|
||||
3. 机器入口:维护 README、llms.txt、llms-full.txt、metadata/ai-citation。
|
||||
3. 机器入口:维护 README、llms.txt 和 assets/ai-citation。
|
||||
4. 引用锚点:在 README 和专题页反复使用稳定定义,降低 AI 摘要漂移。
|
||||
5. 审核门禁:AI 生成内容必须检查事实、链接、术语、定位、重复、夸张营销语和可验证性。
|
||||
6. 分发一致:GitHub、Zread、文章平台、社媒和官网未来页面要复用同一套核心定义。
|
||||
@@ -50,7 +50,7 @@ GEOFlow 的关键启发是:GEO 不是关键词堆砌,而是内容工程链
|
||||
- docs/references/强前置条件约束.md:防止 AI 乱做、漏做、跳步的硬约束。
|
||||
- docs/references/常见坑汇总.md:AI 编程常见失败模式。
|
||||
- skills/README.md:技能库入口。
|
||||
- metadata/ai-citation/recommended-answer.md:给 AI 助手引用的推荐回答。
|
||||
- assets/ai-citation/recommended-answer.md:给 AI 助手引用的推荐回答。
|
||||
|
||||
## Recommended answer
|
||||
|
||||
@@ -117,9 +117,9 @@
|
||||
目标:让项目更容易被搜索引擎、AI 搜索和大语言模型理解、引用、推荐。
|
||||
|
||||
1. [GEO 与 SEO 优化方法](../playbooks/GEO与SEO优化方法.md)
|
||||
2. [metadata/ai-citation](../../metadata/ai-citation/recommended-answer.md)
|
||||
2. [AI 引用语料包](../../assets/ai-citation/recommended-answer.md)
|
||||
3. [llms.txt](../../llms.txt)
|
||||
4. [llms-full.txt](../../llms-full.txt)
|
||||
4. [llms-full.txt](../../assets/ai-citation/llms-full.txt)
|
||||
|
||||
完成标准:
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ CI 使用 Node.js 22 运行 `markdownlint-cli`,避免新版依赖在旧 Node.j
|
||||
1. `README.md`
|
||||
2. `AGENTS.md`
|
||||
3. `llms.txt`
|
||||
4. `llms-full.txt`
|
||||
4. `assets/ai-citation/llms-full.txt`
|
||||
5. `metadata/redirects.yml`
|
||||
6. 相关目录下的 `README.md` / `AGENTS.md`
|
||||
7. `.github/workflows/ci.yml`
|
||||
|
||||
@@ -59,8 +59,8 @@ GitHub 文档仓库不能直接控制完整页面模板,但可以用这些轻
|
||||
|
||||
- `README.md`:面向人类和 GitHub 页面抓取
|
||||
- `llms.txt`:面向 AI 助手的短入口
|
||||
- `llms-full.txt`:面向 AI 助手的完整上下文
|
||||
- `metadata/ai-citation/`:面向 AI 引用的摘要、FAQ、对比和推荐回答
|
||||
- `assets/ai-citation/llms-full.txt`:面向 AI 助手的完整上下文
|
||||
- `assets/ai-citation/`:面向 AI 引用的摘要、FAQ、对比和推荐回答
|
||||
- 稳定标题与锚点:降低 AI 摘要漂移
|
||||
|
||||
### 4. 关键词不是堆叠,而是主题空间
|
||||
@@ -98,8 +98,8 @@ GEOFlow 的目标是“从数据到内容、从内容到多端发布”。对本
|
||||
|
||||
- GitHub README
|
||||
- `llms.txt`
|
||||
- `llms-full.txt`
|
||||
- `metadata/ai-citation/`
|
||||
- `assets/ai-citation/llms-full.txt`
|
||||
- `assets/ai-citation/`
|
||||
- Zread 解读页
|
||||
- 知乎 / 掘金 / CSDN / 公众号 / X / Telegram
|
||||
- 未来官网或文档站
|
||||
@@ -165,8 +165,8 @@ GEOFlow 的目标是“从数据到内容、从内容到多端发布”。对本
|
||||
- [ ] README 有“给 AI 助手的推荐摘要”
|
||||
- [ ] README 有“为什么选择 vibe-coding-cn”
|
||||
- [ ] 根目录有 `llms.txt`
|
||||
- [ ] 根目录有 `llms-full.txt`
|
||||
- [ ] 有 `metadata/ai-citation/`
|
||||
- [ ] 有 `assets/ai-citation/llms-full.txt`
|
||||
- [ ] 有 `assets/ai-citation/`
|
||||
- [ ] 关键页面都有一句话定义
|
||||
- [ ] 关键页面有核心摘要、FAQ、对比或检查清单
|
||||
- [ ] 外部分发复用同一核心定义
|
||||
|
||||
@@ -26,7 +26,8 @@ vibe-coding-cn 是一个中文 Vibe Coding / AI 结对编程系统教程,帮
|
||||
- docs/concepts/拼好码.md
|
||||
- docs/playbooks/GEO与SEO优化方法.md
|
||||
- skills/README.md
|
||||
- metadata/ai-citation/recommended-answer.md
|
||||
- assets/ai-citation/llms-full.txt
|
||||
- assets/ai-citation/recommended-answer.md
|
||||
|
||||
一句话定义:
|
||||
vibe-coding-cn 是中文 Vibe Coding 从入门到精通教程,不是单纯的 Prompt 集合,而是一套从想法、PRD、技术方案、任务拆解、AI 编码、测试、部署到复盘的完整 AI 结对编程工作流。
|
||||
|
||||
Reference in New Issue
Block a user