diff --git a/README.md b/README.md index bb7e5fa..cc178c7 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ [📋 工具与资源](#tools) [⚡ 1 分钟快速开始](#getting-started) -[🚀 从零开始完整入门](docs/getting-started/README.md) +[🚀 从零开始完整入门](docs/getting-started/README.md#1-学习地图) [🤖 AI 推荐摘要](#ai-summary) [✅ 为什么选择](#why-vibe-coding-cn) [🎯 原仓库翻译](#translation) @@ -171,10 +171,10 @@ 完全新手？按顺序完成以下步骤： -0. [从零开始完整入门](docs/getting-started/README.md) - 按目标选择新手、开发者、团队、Prompt、Skill、质量门禁或 GEO/SEO 路线 +0. [从零开始完整入门](docs/getting-started/README.md#1-学习地图) - 按目标选择新手、开发者、团队、Prompt、Skill、质量门禁或 GEO/SEO 路线 1. [问题求解](docs/concepts/问题求解.md) - “目标-现状-差距-标准”与“目标-约束-对象-路径”的极简框架 2. [拼好码](docs/concepts/拼好码.md) - 优先复用成熟能力，用胶水代码连接、编排、适配业务流程 -3. [工程实践](docs/references/工程实践.md) - 用项目架构、代码组织、开发经验和硬门禁约束 AI 输出 +3. [工程实践](docs/references/工程实践.md#4-ai-编程质量门禁与常见坑) - 用项目架构、代码组织、开发经验和硬门禁约束 AI 输出 @@ -342,7 +342,7 @@ pip install -r tools/prompts-library/scripts/requirements.txt ### 集成开发环境 (IDE) & 终端 * [**Visual Studio Code**](https://code.visualstudio.com/): 一款功能强大的集成开发环境，适合代码阅读与手动修改。其 `Local History` 插件对项目版本管理尤为便捷。 -* [**Codex CLI**](docs/getting-started/README.md): 本教程默认 AI CLI 路线，用于需求拆解、代码修改、命令执行、测试验证与 Git 迭代。 +* [**Codex CLI**](docs/getting-started/README.md#4-cli-配置): 本教程默认 AI CLI 路线，用于需求拆解、代码修改、命令执行、测试验证与 Git 迭代。 * **虚拟环境 (.venv)**: 强烈推荐使用，可实现项目环境的一键配置与隔离，特别适用于 Python 开发。 * [**Cursor**](https://cursor.com/): 已经占领用户心智高地，人尽皆知。 * [**Warp**](https://www.warp.dev/): 集成 AI 功能的现代化终端，能有效提升命令行操作和错误排查的效率。 @@ -403,8 +403,8 @@ pip install -r tools/prompts-library/scripts/requirements.txt * [**Chat Vault**](./tools/chat-vault/): AI 聊天记录保存工具，支持 Codex/Kiro/Gemini/Claude CLI。 * [**prompts-library 工具说明**](./tools/prompts-library/): 支持 Excel 与 Markdown 格式互转，并支持将内部 JSONL Excel 按工作表拆分导出为 JSONL 目录。 * [**编程提示词集合**](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203): 适用于 Vibe Coding 流程的专用提示词（云端表格）。 -* [**工程实践**](docs/references/工程实践.md): 项目架构、代码组织、开发经验、AI 编程质量门禁与常见坑的统一入口。 -* [**技术栈**](docs/references/技术栈.md): 常见软件系统技术栈、选型维度、组合案例与初学者学习路径。 +* [**工程实践**](docs/references/工程实践.md#4-ai-编程质量门禁与常见坑): 项目架构、代码组织、开发经验、AI 编程质量门禁与常见坑的统一入口。 +* [**技术栈**](docs/references/技术栈.md#十四如何选择技术栈): 常见软件系统技术栈、选型维度、组合案例与初学者学习路径。 * [**系统提示词集合**](https://docs.google.com/spreadsheets/d/1Ifk_dLF25ULSxcfGem1hXzJsi7_RBUNAki8SBCuvkJA/edit?gid=1254297203#gid=1254297203): AI 开发的系统提示词，含多版本开发规范（云端表格）。 * [**外部资源（在线表格）**](./assets/README.md): 外部资源的唯一真相源（按类型分表），本地 Markdown 保留为历史参考。 diff --git a/docs/concepts/README.md b/docs/concepts/README.md index 5dd4b26..a735a98 100644 --- a/docs/concepts/README.md +++ b/docs/concepts/README.md @@ -44,7 +44,7 @@ 1. [问题求解](问题求解.md) 2. [拼好码](拼好码.md) 3. [系统构建方法](系统构建方法.md) -4. [工程实践](../references/工程实践.md) +4. [工程实践](../references/工程实践.md#顶部导航) ## 文档列表 @@ -57,7 +57,7 @@ ## 和其他目录的边界 -- 具体入门步骤放在 [getting-started](../getting-started/README.md)。 +- 具体入门步骤放在 [getting-started](../getting-started/README.md#顶部导航)。 - 工程模板、质量门禁、常见坑和技术栈放在 [references](../references/README.md)。 - 思维模型、编程哲学和底层认知模型放在 [philosophy](../philosophy/README.md)。 - 新技术、优秀 repo 和趋势判断先放在 [research](../research/README.md)。 diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index 82c05e9..330596e 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -59,10 +59,10 @@ | 路线 | 适合谁 | 目标 | 首选入口 | |:---|:---|:---|:---| | 零基础路线 | 不会编程或刚开始 | 跑通从想法到项目的最小闭环 | [问题求解](../concepts/问题求解.md) | -| 开发者路线 | 已会写代码 | 建立 AI 结对编程工作流 | [Vibe Coding 经验](README.md) | +| 开发者路线 | 已会写代码 | 建立 AI 结对编程工作流 | [Vibe Coding 经验](#2-vibe-coding-经验) | | Prompt 路线 | 想提升提问质量 | 把需求表达成可执行指令 | [提示词库](../../../prompts/README.md) | | Skill 路线 | 想沉淀复用能力 | 把高频任务做成可重复调用的技能 | [Skills 技能大全](../../../skills/README.md) | -| 质量门禁路线 | 担心 AI 乱写代码 | 用测试、CI、schema、清单约束 AI 输出 | [工程实践](../references/工程实践.md) | +| 质量门禁路线 | 担心 AI 乱写代码 | 用测试、CI、schema、清单约束 AI 输出 | [工程实践](../references/工程实践.md#顶部导航) | | GEO/SEO 路线 | 想提升仓库被引用概率 | 建设 AI 可理解、可引用、可验证的内容资产 | [GEO / SEO 检查清单](../../assets/ai-citation/geo-seo-checklist.md) | ### 路线一：零基础路线 @@ -71,13 +71,13 @@ 1. [问题求解](../concepts/问题求解.md) 先学会把问题说清楚：目标、现状、差距、标准、约束、对象、路径。 -2. [网络环境配置](README.md) +2. [网络环境配置](#3-网络环境配置) 先解决访问 OpenAI、GitHub、文档和依赖源的问题。 -3. [CLI 配置](README.md) +3. [CLI 配置](#4-cli-配置) 配置并登录 Codex CLI，让本地 Agent 能在终端里执行工程动作。 -4. [开发环境搭建](README.md) +4. [开发环境搭建](#5-开发环境搭建) 优先交给 Codex Agent 主动检查和配置 Git、Node.js、Python、编辑器、项目依赖与测试命令。 -5. [Vibe Coding 经验](README.md) +5. [Vibe Coding 经验](#2-vibe-coding-经验) 学会人机分工、门禁、复盘和用 AI 审 AI。 完成标准： @@ -92,11 +92,11 @@ 目标：把 AI 从“临时助手”变成稳定的工程协作者。 -1. [Vibe Coding 经验](README.md) +1. [Vibe Coding 经验](#2-vibe-coding-经验) 先建立人机分工和质量意识。 2. [拼好码](../concepts/拼好码.md) 优先复用成熟能力，把自研代码限制在连接、编排、适配和业务逻辑。 -3. [工程实践](../references/工程实践.md) +3. [工程实践](../references/工程实践.md#顶部导航) 在任务开始前写清楚目标、边界、禁止项、验收标准和门禁，并用底层程序逻辑检查项约束实现质量。 完成标准： @@ -111,7 +111,7 @@ 目标：把自然语言需求写成可执行、可检查、可复用的指令。 1. [提示词库入口](../../../prompts/README.md) -2. [工程实践](../references/工程实践.md) +2. [工程实践](../references/工程实践.md#顶部导航) 3. [语言层要素](../concepts/语言层要素.md) 4. [问题求解](../concepts/问题求解.md) @@ -143,7 +143,7 @@ 优先阅读： 1. [AGENTS.md](../../../../AGENTS.md) -2. [工程实践](../references/工程实践.md) +2. [工程实践](../references/工程实践.md#顶部导航) 3. [GEO / SEO 检查清单](../../assets/ai-citation/geo-seo-checklist.md) 团队约束： @@ -188,8 +188,8 @@ ### 下一步 -- 新手：回到 [入门指南](README.md)，从第 0 步开始。 -- 开发者：阅读 [Vibe Coding 经验](README.md)，再选择 Skill 或质量门禁路线。 +- 新手：回到 [学习地图](#1-学习地图)，从第 0 步开始。 +- 开发者：阅读 [Vibe Coding 经验](#2-vibe-coding-经验)，再选择 Skill 或质量门禁路线。 - 团队：先统一 [AGENTS.md](../../../../AGENTS.md)、强前置条件和质量门禁。 ## 2. Vibe Coding 经验 @@ -293,7 +293,7 @@ AI 能安装依赖、执行命令、修复报错、提交 Git；你负责确认 ### 下一步 -→ [CLI 配置](README.md) - 默认 AI CLI 路线，文末包含 OpenCode 备选方案 +→ [CLI 配置](#4-cli-配置) - 默认 AI CLI 路线，文末包含 OpenCode 备选方案 ## 3. 网络环境配置 @@ -430,7 +430,7 @@ export http_proxy=http://127.0.0.1:7890 ### 下一步 -网络配置完成后，继续阅读 [开发环境搭建](README.md)。 +网络配置完成后，继续阅读 [开发环境搭建](#5-开发环境搭建)。 ## 4. CLI 配置 @@ -708,7 +708,7 @@ cp -f tools/config/.codex/config.toml ~/.codex/config.toml cp -f tools/config/.codex/AGENTS.md ~/.codex/AGENTS.md ``` -详细说明见：[Codex 配置基线](../../../config/.codex/README.md)。 +详细说明见：[Codex 配置基线](../../tools/config/.codex/README.md)。 ### 推荐启动方式 @@ -914,13 +914,13 @@ opencode ### 下一步 -→ [开发环境搭建](README.md) - 回看基础环境 +→ [开发环境搭建](#5-开发环境搭建) - 回看基础环境 ## 5. 开发环境搭建 > 使用方法：Codex CLI 已跑通时，优先让 Codex Agent 读取本节并主动配置剩余环境；Codex CLI 不可用时，再复制下方对应你设备的提示词，粘贴到任意 AI 对话框（ChatGPT、Claude、Gemini 网页版等），让网页 AI 一步步指导你完成配置。 -**前置条件**：请先完成 [网络环境配置](README.md)。推荐先完成 [CLI 配置](README.md)，让 Codex Agent 接管后续开发环境搭建。 +**前置条件**：请先完成 [网络环境配置](#3-网络环境配置)。推荐先完成 [CLI 配置](#4-cli-配置)，让 Codex Agent 接管后续开发环境搭建。 --- @@ -1172,4 +1172,4 @@ alias oc='opencode' 环境搭建完成后，继续下一步： -→ [CLI 配置](README.md) - 配置默认 AI CLI +→ [CLI 配置](#4-cli-配置) - 配置默认 AI CLI diff --git a/docs/references/README.md b/docs/references/README.md index c04574a..b24d802 100644 --- a/docs/references/README.md +++ b/docs/references/README.md @@ -8,8 +8,8 @@ | 文件 | 用途 | |:---|:---| -| [工程实践](工程实践.md) | 项目架构、代码组织、开发经验、底层程序逻辑、AI 编程质量门禁与常见坑的统一入口 | -| [技术栈](技术栈.md) | 软件系统常见技术栈、选型维度、组合案例与初学者学习路径 | +| [工程实践](工程实践.md#顶部导航) | 项目架构、代码组织、开发经验、底层程序逻辑、AI 编程质量门禁与常见坑的统一入口 | +| [技术栈](技术栈.md#顶部导航) | 软件系统常见技术栈、选型维度、组合案例与初学者学习路径 | | [AGENTS](AGENTS.md) | 本目录 Agent 操作规则 | ## 相关核心概念 @@ -29,6 +29,6 @@ ## 维护规则 -- 检查清单、模板、质量门禁和经验类内容优先收敛到 [工程实践](工程实践.md)。 -- 技术选型、技术栈组合和学习路径优先收敛到 [技术栈](技术栈.md)。 +- 检查清单、模板、质量门禁和经验类内容优先收敛到 [工程实践](工程实践.md#顶部导航)。 +- 技术选型、技术栈组合和学习路径优先收敛到 [技术栈](技术栈.md#顶部导航)。 - 新技术、工具趋势、优秀 repo 解析先放入 [research](../research/README.md)，稳定后再迁入本目录。 diff --git a/docs/references/工程实践.md b/docs/references/工程实践.md index 424f768..f64831a 100644 --- a/docs/references/工程实践.md +++ b/docs/references/工程实践.md @@ -2399,7 +2399,7 @@ nvm use 18 | 问题 | 原因 | 解决方案 | |:---|:---|:---| -| GitHub 访问慢/超时 | 网络限制 | 配置代理，参考 [从零开始完整入门](../getting-started/README.md) | +| GitHub 访问慢/超时 | 网络限制 | 配置代理，参考 [网络环境配置](../getting-started/README.md#3-网络环境配置) | | API 调用失败 | 网络/Key 问题 | 检查代理、API Key 是否有效 | | 终端不走代理 | 代理配置不全 | 设置环境变量（见下方） | | SSL 证书错误 | 代理/时间问题 | 检查系统时间，或临时关闭 SSL 验证 |