|
| 1 | +# 🤖 Awesome AI Agent Guide |
| 2 | + |
| 3 | +本文档旨在指导 AI Agent 如何规范、安全地为 **Awesome AI** 项目生成内容、执行更新和部署。 |
| 4 | + |
| 5 | +## 📋 项目概览 |
| 6 | +- **仓库**: `doocs/awesome-ai` |
| 7 | +- **线上地址**: https://ai.doocs.org |
| 8 | +- **技术栈**: Astro + Tailwind CSS |
| 9 | +- **核心策略**: **严格双语同步** (中文/英文),所有核心内容更新必须包含双语版本。 |
| 10 | + |
| 11 | +## 📁 项目结构 |
| 12 | +```text |
| 13 | +awesome-ai/ |
| 14 | +├── src/ |
| 15 | +│ ├── content/ # 📂 中文内容源文件 |
| 16 | +│ │ ├── daily/ # 日报 (文件名: YYYY-MM-DD.md) |
| 17 | +│ │ ├── weekly/ # 周报 (文件名: YYYY-wWW.md) |
| 18 | +│ │ ├── topics/ # 专题深度讨论 |
| 19 | +│ │ ├── tools/ # 工具推荐分类 |
| 20 | +│ │ └── models/ # 模型排行榜分类 |
| 21 | +│ ├── content/en/ # 📂 英文内容源文件 (结构对应中文) |
| 22 | +│ ├── pages/ # Astro 路由页面 |
| 23 | +│ ├── components/ # UI 组件 |
| 24 | +│ └── i18n/ # 国际化翻译字典 (zh.json / en.json) |
| 25 | +├── public/ # 📂 静态资源 (⚠️ 包含关键文件: CNAME) |
| 26 | +├── scripts/ # 🔧 部署脚本 (deploy_ai_pulse.py) |
| 27 | +├── README.md # 📖 项目介绍 (中文) |
| 28 | +└── README_EN.md # 📖 项目介绍 (英文) |
| 29 | +``` |
| 30 | + |
| 31 | +## 📝 内容生成规范 (CRITICAL) |
| 32 | + |
| 33 | +### 1. Frontmatter 格式红线 ⚠️ |
| 34 | +所有 Markdown 文件的 Frontmatter **必须**严格符合 `src/content/config.ts` 中的 Schema 定义。 |
| 35 | + |
| 36 | +- **致命错误**:`date` 字段**必须加双引号**! |
| 37 | + - ✅ `date: "2026-05-11"` (正确) |
| 38 | + - ❌ `date: 2026-05-11` (会导致 Astro 构建失败) |
| 39 | + |
| 40 | +**标准模板:** |
| 41 | +```yaml |
| 42 | +--- |
| 43 | +title: "Awesome AI 日报 | 2026-05-11" |
| 44 | +date: "2026-05-11" |
| 45 | +tags: ["Tag1", "Tag2"] |
| 46 | +summary: "简短总结..." |
| 47 | +--- |
| 48 | +``` |
| 49 | + |
| 50 | +### 2. 标题与排版统一规范 ⭐️ |
| 51 | +所有生成的 Markdown 文件在标题层级(Heading levels)上必须保持高度统一。 |
| 52 | + |
| 53 | +**📄 日报 (Daily) 模板:** |
| 54 | +- 不使用 `## 今日要闻` 等包裹标题,直接以 `## 1.` 开始。 |
| 55 | +- 每条新闻使用 `##` (H2) 作为标题。 |
| 56 | +- 观点部分使用引用块 `> **Awesome AI 观点:**`。 |
| 57 | +```markdown |
| 58 | +## 1. 新闻标题 |
| 59 | +新闻内容段落... |
| 60 | +> **Awesome AI 观点:** 观点内容... |
| 61 | +
|
| 62 | +## 2. 新闻标题 |
| 63 | +新闻内容段落... |
| 64 | + |
| 65 | +## 其他动态 |
| 66 | +- **公司/人物** 动态详情 |
| 67 | +``` |
| 68 | + |
| 69 | +**📰 周报 (Weekly) 模板:** |
| 70 | +- 开头使用一个 `#` (H1) 作为本期主标题。 |
| 71 | +- 每个独立板块使用 `##` (H2)。 |
| 72 | +```markdown |
| 73 | +# 本周聚焦:核心主题一句话概括 |
| 74 | + |
| 75 | +简介段落... |
| 76 | + |
| 77 | +## 板块一标题 |
| 78 | +内容... |
| 79 | + |
| 80 | +## 板块二标题 |
| 81 | +内容... |
| 82 | +``` |
| 83 | + |
| 84 | +**💡 专题 (Topics) 模板:** |
| 85 | +- 不使用 `#` (H1),所有内容区块使用 `##` (H2)。 |
| 86 | +```markdown |
| 87 | +> 引导语/核心观点引用 |
| 88 | +
|
| 89 | +## 板块一标题 |
| 90 | +内容... |
| 91 | +``` |
| 92 | + |
| 93 | +### 3. 内容质量 |
| 94 | +- **观点输出**:每条资讯/工具推荐后需包含 `> **Awesome AI 观点/View:**`,提供深度分析,拒绝简单堆砌。 |
| 95 | +- **双语一致**:英文版内容需适配英文语境,保持专业度。 |
| 96 | + |
| 97 | +## 🔄 更新与部署流程 |
| 98 | + |
| 99 | +### Step 1: 生成与验证 |
| 100 | +1. 在 `src/content/` 和 `src/content/en/` 生成对应的双语 Markdown 文件。 |
| 101 | +2. 运行本地验证:`npm run build`。**只有构建成功 (Exit 0) 的文件才允许提交。** |
| 102 | + |
| 103 | +### Step 2: 评估并同步 README (必须执行) ⭐️ |
| 104 | +**规则**:在更新内容后,Agent **必须**评估本次内容的重要性,决定是否更新根目录的 `README.md` 和 `README_EN.md`。 |
| 105 | + |
| 106 | +- **何时更新 README?** |
| 107 | + - 新增了 **Tools** 分类或 **Tools** 推荐。 |
| 108 | + - 新增了 **Models** 排行榜或模型数据。 |
| 109 | + - 新增了高价值的 **Topics**(专题讨论)。 |
| 110 | + - 项目结构发生重大变化(新增模块)。 |
| 111 | +- **操作要求**: |
| 112 | + - 若评估需要更新,**必须同时修改** 中文版 (`README.md`) 和 英文版 (`README_EN.md`)。 |
| 113 | + - 保持中英文描述的准确性和一致性。 |
| 114 | + |
| 115 | +### Step 3: 部署推送 |
| 116 | +使用 `scripts/deploy_ai_pulse.py` 推送文件。 |
| 117 | +```bash |
| 118 | +# 推送中文 |
| 119 | +python3 scripts/deploy_ai_pulse.py src/content/daily/YYYY-MM-DD.md "docs: add daily news YYYY-MM-DD" |
| 120 | + |
| 121 | +# 推送英文 |
| 122 | +python3 scripts/deploy_ai_pulse.py src/content/en/daily/YYYY-MM-DD.md "docs: add daily news EN YYYY-MM-DD" |
| 123 | +``` |
| 124 | + |
| 125 | +## 🔒 安全与敏感信息规范 |
| 126 | +1. **Token 保密**: |
| 127 | + - 部署脚本 (`deploy_ai_pulse.py`) 会从环境文件读取 Token。**Agent 在执行脚本时,绝不能在日志、回复或输出中打印 Token 的值。** |
| 128 | + - 若遇到认证失败,仅提示 "Authentication failed" 或 "Check token validity"。 |
| 129 | +2. **禁止硬编码**: |
| 130 | + - 永远不要将 Token 硬编码在生成的脚本代码或 Markdown 内容中。 |
| 131 | + - 仓库根目录或 `public/` 下禁止出现 `.env` 或包含密钥的临时文件。 |
| 132 | + |
| 133 | +## 🚀 Git Commit 规范 |
| 134 | +遵循 [Conventional Commits](https://www.conventionalcommits.org/): |
| 135 | + |
| 136 | +| Type | 场景 | 示例 | |
| 137 | +|:---|:---|:---| |
| 138 | +| `docs` | 日报、周报、专题文章、README | `docs: add daily news 2026-05-11` | |
| 139 | +| `feat` | 新功能 (页面、组件) | `feat: add dark mode toggle` | |
| 140 | +| `fix` | 修复错误 (格式、链接、代码) | `fix: correct date format in daily news` | |
| 141 | +| `chore` | 构建配置、CNAME、依赖 | `chore: update CNAME to ai.doocs.org` | |
| 142 | +| `refactor` | 代码重构 (无功能变动) | `refactor: optimize image loading` | |
0 commit comments