Files
vibe-coding-cn/docs/getting-started/AGENTS.md
T
2026-05-03 03:03:03 +08:00

35 lines
1.2 KiB
Markdown

# Getting Started 目录 Agent 指南
## 目录职责
`docs/getting-started/` 存放从零开始的线性入门教程。
本目录面向:
- 新电脑、新系统、零基础用户。
- 第一次配置网络、Codex CLI、开发环境的人。
- 想从想法走到可运行项目的学习者。
## 文件地图
```text
getting-started/
├── README.md # 从零开始完整入门教程
└── AGENTS.md # 本目录操作规则
```
## 修改规则
- 保持 `README.md` 作为单文件线性教程,避免重新拆散为多个碎片文档。
- 新增步骤时,必须说明适用系统、前置条件、执行命令和成功判断。
- 命令必须可复制执行;涉及平台差异时分别写明 Windows、WSL、Linux 或 macOS。
- 默认路线优先是:网络环境和订阅准备 -> Codex CLI -> 让 Agent 配置后续环境。
- 不把抽象方法论堆进本目录;方法论应链接到 `docs/concepts/``docs/references/`
## 质量要求
- 假设读者没有前置依赖。
- 每个关键步骤都要有失败时的处理方法。
- 避免“自行安装”“配置一下”这类不可执行表述。
- 修改后必须跑本地链接检查。