基础教程
Agent 规则
用 AGENTS.md 固化项目约束和验收方式。
为什么要写规则
AGENTS.md 是给 AI 编码助手的项目约束。它应该告诉 Agent：
- 当前项目是什么技术栈。
- 内容应该放在哪里。
- 修改后必须跑什么检查。
- 哪些文件或页面必须保持兼容。
当前项目规则
这个站点的关键规则是：
- 文档内容放在
content/。 - 使用编号目录控制侧边栏顺序。
- 保留 Nuxt UI Docs Template 的布局。
- 完成后运行
pnpm lint、pnpm typecheck、pnpm build。 - 视觉修改要用浏览器截图检查桌面端和移动端。
推荐写法
# Project Rules
This project is a Nuxt UI Docs Template based tutorial site.
Goals:
- Preserve /codex/model and content/3.codex/5.model.md.
- Put tutorial, model evaluation, workflow, and Gallery pages under content/.
- Use numeric prefixes to control sidebar order.
- Before finishing, run pnpm lint, pnpm typecheck, pnpm check:routes, and pnpm build.
不要写什么
| 弱规则 | 更好的规则 |
|---|---|
| 做得好看一点 | 修改后保存桌面和移动端截图 |
| 保持质量 | 跑 lint、typecheck、route check、build |
| 不要乱改 | 只改用户指定范围，保留 /codex/model 基线 |
| 注意上下文 | 在长任务里记录已改文件和未验证风险 |
好规则的标准
规则应该短、具体、可执行。不要写空泛口号，尽量写成可以被命令或文件路径验证的要求。
验证规则是否有效
让 Agent 做一个小任务，然后观察它是否主动读取 AGENTS.md、是否只改相关文件、是否按规则运行检查。如果没有执行规则，说明规则写得太泛或位置不对。
继续阅读
按当前页面继续跳到相关教程、评测、路线或 Gallery 示例。