mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-07-29 03:37:44 +00:00
1.2 KiB
1.2 KiB
Documents 目录 Agent 指南
目录用途
docs/ 存放项目核心知识库文档,包含入门路径、核心概念与参考清单。
目录结构
docs/
├── README.md # 知识库总索引
├── getting-started/ # 从零开始、学习地图、环境与 AI CLI 配置
├── concepts/ # 核心概念、方法论与底层模型
└── references/ # 清单、约束、常见坑、模板
关键入口
README.md:知识库总索引。getting-started/README.md:从零开始完整入门,包含学习地图、Vibe Coding 经验、网络配置、CLI 配置与开发环境搭建。concepts/拼好码.md:复用优先、能力编排、边界治理与工程门禁。
操作规范
允许
- 新增/修改文档内容。
- 修复错误和过时信息。
- 为每个一级目录维护
README.md作为索引入口(如存在)。
禁止
- 删除现有文档(除非明确要求)。
- 大规模重命名/移动文件导致链接失效(如必须调整,需同步更新引用)。
命名规范
- 文件名使用中文或清晰英文。
- 使用 Markdown 格式。
- 目录名使用简短英文,保证跨平台与链接稳定。