# Getting Started 目录 Agent 指南 ## 目录职责 `docs/getting-started/` 存放从零开始的线性入门教程。 本目录面向: - 新电脑、新系统、零基础用户。 - 第一次配置网络、Codex CLI、开发环境的人。 - 想从想法走到可运行项目的学习者。 ## 文件地图 ```text getting-started/ ├── README.md # 从零开始索引入口 ├── vibe-coding-experience.md ├── learning-map.md ├── network-environment.md ├── cli-setup.md ├── development-environment.md └── AGENTS.md # 本目录操作规则 ``` ## 修改规则 - 继承 `docs/AGENTS.md` 的 README 结构契约:H1 后直接进入 `## 字多不看`,再按 `快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文` 排列。 - `README.md` 只做索引入口;正文写入同目录独立主题文档。 - 新增步骤时,必须说明适用系统、前置条件、执行命令和成功判断。 - 命令必须可复制执行;涉及平台差异时分别写明 Windows、WSL、Linux 或 macOS。 - 默认路线优先是:网络环境和订阅准备 -> Codex CLI -> 让 Agent 配置后续环境。 - 不把抽象方法论堆进本目录;方法论应链接到 `docs/concepts/` 或 `docs/references/`。 - 不在 README 正文中写 `和其他目录的边界` 或 `维护规则`;维护者规则只写本文件。 ## 质量要求 - 假设读者没有前置依赖。 - 每个关键步骤都要有失败时的处理方法。 - 避免“自行安装”“配置一下”这类不可执行表述。 - 修改后必须运行 `make sync-doc-toc` 和 `make test`。