mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-16 12:28:06 +00:00
chore: migrate repository to standard knowledge base layout
This commit is contained in:
@@ -8,21 +8,21 @@
|
||||
|
||||
### 允许的操作
|
||||
- 读取、修改顶层文档:`README.md`、`AGENTS.md`、`CONTRIBUTING.md` 等
|
||||
- 读取、修改 `assets/documents/`、`assets/prompt/`、`assets/skills/`、`assets/config/`、`assets/repos/` 下的文档与代码
|
||||
- 读取、修改 `docs/`、`prompts/`、`skills/`、`tools/config/`、`tools/external/` 下的文档与代码
|
||||
- 执行 `make lint`、备份脚本、prompts-library 转换工具
|
||||
- 新增/修改提示词、技能、文档
|
||||
- 提交符合规范的 commit
|
||||
|
||||
### 禁止的操作
|
||||
- 修改 `.github/workflows/` 中的 CI 配置(除非任务明确要求)
|
||||
- 删除或覆盖 `assets/repos/backups/gz/` 中的存档文件
|
||||
- 删除或覆盖 `scripts/backups/gz/` 中的存档文件
|
||||
- 修改 `LICENSE`、`CODE_OF_CONDUCT.md`
|
||||
- 在代码中硬编码密钥、Token 或敏感凭证
|
||||
- 未经确认的大范围重构
|
||||
|
||||
### 敏感区域(禁止自动修改)
|
||||
- `.github/workflows/*.yml` - CI/CD 配置
|
||||
- `assets/repos/backups/gz/` - 历史备份存档
|
||||
- `scripts/backups/gz/` - 历史备份存档
|
||||
- `.env*` 文件(如存在)
|
||||
|
||||
---
|
||||
@@ -67,13 +67,13 @@ git push origin develop
|
||||
| `make help` | 列出所有 Make 目标 | 无 |
|
||||
| `make lint` | 校验全仓库 Markdown | 需安装 markdownlint-cli |
|
||||
| `git submodule update --init --recursive` | 初始化外部 Git 仓库指针 | Git |
|
||||
| `bash assets/repos/backups/一键备份.sh` | 创建完整项目备份 | 无 |
|
||||
| `python3 assets/repos/backups/快速备份.py` | Python 版备份脚本 | Python 3.8+ |
|
||||
| `cd assets/repos/prompts-library && python3 main.py` | 提示词格式转换 | `pip install -r assets/repos/prompts-library/requirements.txt` |
|
||||
| `bash scripts/backups/一键备份.sh` | 创建完整项目备份 | 无 |
|
||||
| `python3 scripts/backups/快速备份.py` | Python 版备份脚本 | Python 3.8+ |
|
||||
| `cd tools/prompts-library && python3 main.py` | 提示词格式转换 | `pip install -r tools/prompts-library/requirements.txt` |
|
||||
|
||||
### Python 依赖来源
|
||||
- prompts-library 主入口依赖:`assets/repos/prompts-library/requirements.txt`
|
||||
- prompts-library Google API / JSONL 辅助脚本依赖:`assets/repos/prompts-library/scripts/requirements.txt`
|
||||
- prompts-library 主入口依赖:`tools/prompts-library/requirements.txt`
|
||||
- prompts-library Google API / JSONL 辅助脚本依赖:`tools/prompts-library/scripts/requirements.txt`
|
||||
|
||||
### prompts-library 支持的转换模式
|
||||
1. Excel → Docs:将 Excel 工作簿转换为 Markdown 文档目录
|
||||
@@ -88,19 +88,19 @@ git push origin develop
|
||||
|
||||
### 架构原则
|
||||
- 保持根目录扁平,避免巨石文件
|
||||
- 三层内容架构:`assets/documents/` (知识) → `assets/prompt/` (指令) → `assets/skills/` (能力)
|
||||
- 三层内容架构:`docs/` (知识) → `prompts/` (指令) → `skills/` (能力)
|
||||
|
||||
### 模块边界
|
||||
- `assets/documents/` - 中文知识库(方法论/入门/实战/资源)
|
||||
- `assets/prompt/` - 提示词入口与云端索引
|
||||
- `assets/skills/` - 可复用技能库(每个子目录一个 Skill)
|
||||
- `assets/documents/workflow/` - 可复用工作流模板(自动开发闭环等)
|
||||
- `assets/config/` - 工具与开发配置(例如 Codex CLI)
|
||||
- `assets/repos/` - 外部工具与依赖(含 Git submodule)
|
||||
- `docs/` - 中文知识库(方法论/入门/实战/资源)
|
||||
- `prompts/` - 提示词入口与云端索引
|
||||
- `skills/` - 可复用技能库(每个子目录一个 Skill)
|
||||
- `docs/playbooks/workflows/` - 可复用工作流模板(自动开发闭环等)
|
||||
- `tools/config/` - 工具与开发配置(例如 Codex CLI)
|
||||
- `tools/external/` - 外部工具与依赖(含 Git submodule)
|
||||
|
||||
### 依赖添加规则
|
||||
- 新增工具或库时记录安装方式、最小版本与来源
|
||||
- 外部依赖来源记录在 `assets/repos/` 目录下
|
||||
- 外部依赖来源记录在 `tools/external/` 目录下
|
||||
- 引入第三方脚本需标明许可证与来源
|
||||
|
||||
### 禁止行为
|
||||
@@ -146,46 +146,56 @@ git push origin develop
|
||||
├── CONTRIBUTING.md # 贡献指南
|
||||
├── .gitignore # Git 忽略规则
|
||||
│
|
||||
├── assets/ # 外部资源(指向在线表格)
|
||||
│ ├── README.md # 远程表格索引(唯一真相源)
|
||||
├── docs/ # 核心知识库
|
||||
│ ├── README.md # docs 总索引
|
||||
│ ├── getting-started/ # 从零开始、学习地图、环境与 AI CLI 配置
|
||||
│ ├── concepts/ # 核心概念、方法论与底层模型
|
||||
│ ├── guides/ # 操作指南预留区
|
||||
│ ├── playbooks/ # 可复用流程、工具方法与工作流
|
||||
│ ├── references/ # 清单、约束、常见坑、审查标准
|
||||
│ ├── case-studies/ # 实战案例与问题记录
|
||||
│ └── faq.md # 高频问题
|
||||
│
|
||||
├── prompts/ # 提示词库入口(指向云端表格)
|
||||
│ ├── README.md # 在线表格链接
|
||||
│ └── AGENTS.md # prompts/ 目录规则
|
||||
│
|
||||
├── skills/ # 技能库(每个子目录一个 Skill)
|
||||
│ ├── README.md # skills 总览与索引
|
||||
│ ├── AGENTS.md # skills/ 目录规则
|
||||
│ ├── auto-skill/ # 元技能核心
|
||||
│ ├── sop-generator/ # SOP 生成
|
||||
│ └── ... # 更多技能
|
||||
│
|
||||
├── assets/ # 静态资产与外部资源入口
|
||||
│ ├── README.md # 外部资源在线表格入口
|
||||
│ ├── AGENTS.md # assets/ 目录规则
|
||||
│ ├── config/ # 工具与开发配置
|
||||
│ │ └── .codex/ # Codex CLI 配置(项目级)
|
||||
│ │ ├── config.toml # Codex CLI 配置文件
|
||||
│ │ └── AGENTS.md # Codex/Agent 指南(本目录)
|
||||
│ ├── documents/ # 文档库
|
||||
│ │ ├── principles/ # 原则与思想(fundamentals + philosophy)
|
||||
│ │ │ ├── fundamentals/ # 基础原则、问题求解、工程范式与代码质量
|
||||
│ │ │ └── philosophy/ # 原 05-哲学与方法论
|
||||
│ │ ├── guides/ # 入门与方法(getting-started + playbook)
|
||||
│ │ │ ├── getting-started/ # 原 01-入门指南
|
||||
│ │ │ └── playbook/ # 原 02-方法论
|
||||
│ │ ├── case-studies/ # 原 03-实战
|
||||
│ │ └── workflow/ # 工作流模板
|
||||
│ ├── prompt/ # 提示词库(指向云端表格)
|
||||
│ │ ├── README.md # 在线表格链接
|
||||
│ │ └── AGENTS.md # prompt/ 目录规则
|
||||
│ ├── skills/ # 技能库(扁平化,详见 assets/skills/README.md)
|
||||
│ │ ├── README.md # skills 总览与索引
|
||||
│ │ ├── AGENTS.md # skills/ 目录规则
|
||||
│ │ ├── auto-skill/ # 元技能核心
|
||||
│ │ ├── sop-generator/ # SOP 生成
|
||||
│ │ └── ... # 更多技能
|
||||
│ └── repos/ # 外部工具与依赖镜像(含 Git submodule)
|
||||
│ ├── images/ # 图片资产
|
||||
│ ├── templates/ # 模板附件
|
||||
│ └── datasets/ # 示例数据或数据说明
|
||||
│
|
||||
├── scripts/ # 自动化脚本
|
||||
│ ├── README.md # scripts 目录说明
|
||||
│ └── backups/ # 备份脚本与存档忽略规则
|
||||
│
|
||||
├── tools/ # 工具、本地配置与外部仓库
|
||||
│ ├── README.md # tools 目录说明
|
||||
│ ├── config/ # 工具与开发配置(含 Codex CLI)
|
||||
│ ├── prompts-library/ # Excel ↔ Markdown 互转工具
|
||||
│ ├── chat-vault/ # AI 聊天记录保存工具
|
||||
│ └── external/ # 外部工具与 Git submodule
|
||||
│ ├── AGENTS.md # external 目录规则
|
||||
│ ├── README.md # 外部工具索引
|
||||
│ ├── AGENTS.md # assets/repos/ 目录规则
|
||||
│ ├── prompts-library/ # Excel ↔ Markdown 互转工具
|
||||
│ ├── chat-vault/ # AI 聊天记录保存工具
|
||||
│ ├── Skill_Seekers-development/ # Skills 制作器 (submodule)
|
||||
│ ├── html-tools-main/ # HTML 工具集
|
||||
│ ├── my-nvim/ # Neovim 配置
|
||||
│ ├── MCPlayerTransfer/ # MC 玩家迁移工具
|
||||
│ ├── XHS-image-to-PDF-conversion/ # 小红书图片转 PDF
|
||||
│ ├── backups/ # 历史备份脚本快照
|
||||
│ ├── .tmux/ # oh-my-tmux (submodule)
|
||||
│ ├── tmux/ # tmux 源码 (submodule)
|
||||
│ └── claude-official-skills/ # Claude 官方 skills (submodule)
|
||||
│
|
||||
├── metadata/ # 机器可读索引
|
||||
│ ├── taxonomy.yml # 分类体系
|
||||
│ ├── glossary.yml # 术语表
|
||||
│ └── redirects.yml # 重命名/迁移映射
|
||||
│
|
||||
├── .github/ # GitHub 配置
|
||||
│ ├── workflows/ # CI/CD 工作流
|
||||
│ │ ├── ci.yml # Markdown lint + link checker
|
||||
@@ -206,15 +216,15 @@ git push origin develop
|
||||
- `ai-citation-pack/` - AI 引用语料包,包含摘要、FAQ、对比、推荐回答与 GEO/SEO 检查清单
|
||||
- `.github/lint_config.json` - markdownlint 规则,供 `make lint` 与 CI 共用
|
||||
- `.github/workflows/ci.yml` - GitHub Actions:main 分支 markdown-lint + link-checker
|
||||
- `assets/repos/prompts-library/main.py` - 提示词转换工具入口
|
||||
- `assets/repos/backups/一键备份.sh` - 备份脚本入口
|
||||
- `assets/documents/guides/getting-started/Codex-CLI配置.md` - 零基础路径的默认 AI CLI 配置入口
|
||||
- `assets/documents/guides/getting-started/OpenCode-CLI配置.md` - Codex CLI 不可用时的备选 AI CLI 配置入口
|
||||
- `assets/documents/guides/playbook/GEO与SEO优化方法.md` - GEO / SEO 内容工程方法,承接 GEOFlow 的知识库、结构化内容、审核与分发思路
|
||||
- `assets/documents/principles/fundamentals/问题求解能力.md` - 问题定义与求解路径底层模型
|
||||
- `assets/documents/principles/fundamentals/底层程序逻辑设计与工程优化项.md` - 底层程序逻辑与工程优化检查项
|
||||
- `assets/skills/tmux-autopilot/` - tmux 自动化操控技能(基于 oh-my-tmux,含 capture-pane/send-keys/蜂群巡检脚本)
|
||||
- `assets/skills/sop-generator/` - SOP 生成与规范化技能(输入资料/需求 -> 标准 SOP)
|
||||
- `tools/prompts-library/main.py` - 提示词转换工具入口
|
||||
- `scripts/backups/一键备份.sh` - 备份脚本入口
|
||||
- `docs/getting-started/Codex-CLI配置.md` - 零基础路径的默认 AI CLI 配置入口
|
||||
- `docs/getting-started/OpenCode-CLI配置.md` - Codex CLI 不可用时的备选 AI CLI 配置入口
|
||||
- `docs/playbooks/GEO与SEO优化方法.md` - GEO / SEO 内容工程方法,承接 GEOFlow 的知识库、结构化内容、审核与分发思路
|
||||
- `docs/concepts/问题求解能力.md` - 问题定义与求解路径底层模型
|
||||
- `docs/references/底层程序逻辑设计与工程优化项.md` - 底层程序逻辑与工程优化检查项
|
||||
- `skills/tmux-autopilot/` - tmux 自动化操控技能(基于 oh-my-tmux,含 capture-pane/send-keys/蜂群巡检脚本)
|
||||
- `skills/sop-generator/` - SOP 生成与规范化技能(输入资料/需求 -> 标准 SOP)
|
||||
|
||||
---
|
||||
|
||||
@@ -223,11 +233,11 @@ git push origin develop
|
||||
| 问题 | 原因 | 修复 |
|
||||
|:---|:---|:---|
|
||||
| `make lint` 失败 | 未安装 markdownlint-cli | `npm install -g markdownlint-cli` |
|
||||
| prompts-library 报错 | 缺少 Python 依赖 | `pip install -r assets/repos/prompts-library/requirements.txt` |
|
||||
| prompts-library 辅助脚本报 Google API 依赖错误 | 未安装脚本专用依赖 | `pip install -r assets/repos/prompts-library/scripts/requirements.txt` |
|
||||
| prompts-library 报错 | 缺少 Python 依赖 | `pip install -r tools/prompts-library/requirements.txt` |
|
||||
| prompts-library 辅助脚本报 Google API 依赖错误 | 未安装脚本专用依赖 | `pip install -r tools/prompts-library/scripts/requirements.txt` |
|
||||
| CI markdown-lint 失败 | Markdown 规则违规或本地未按 `.github/lint_config.json` 校验 | 运行 `make lint`,按输出修复对应 Markdown |
|
||||
| CI link-checker 失败 | 文档中存在失效链接 | 检查并修复 Markdown 中的链接 |
|
||||
| 备份脚本权限不足 | Shell 脚本无执行权限 | `chmod +x assets/repos/backups/一键备份.sh` |
|
||||
| 备份脚本权限不足 | Shell 脚本无执行权限 | `chmod +x scripts/backups/一键备份.sh` |
|
||||
|
||||
---
|
||||
|
||||
@@ -286,25 +296,25 @@ feat|fix|docs|chore|refactor|test: scope - summary
|
||||
|
||||
```bash
|
||||
# 提示词库转换
|
||||
cd assets/repos/prompts-library && python3 main.py
|
||||
cd tools/prompts-library && python3 main.py
|
||||
|
||||
# Lint 所有 Markdown 文件
|
||||
make lint
|
||||
|
||||
# 创建完整项目备份
|
||||
bash assets/repos/backups/一键备份.sh
|
||||
bash scripts/backups/一键备份.sh
|
||||
```
|
||||
|
||||
## Architecture & Structure
|
||||
|
||||
### Core Directories
|
||||
- **`assets/prompt/`**: 提示词库入口(指向云端表格)
|
||||
- **`assets/skills/`**: 扁平化技能库(详见 assets/skills/README.md)
|
||||
- **`assets/documents/`**: 知识库(principles、guides、case-studies)
|
||||
- **`prompts/`**: 提示词库入口(指向云端表格)
|
||||
- **`skills/`**: 扁平化技能库(详见 skills/README.md)
|
||||
- **`docs/`**: 知识库(principles、guides、case-studies)
|
||||
- **`assets/`**: 外部资源(在线表格)入口与使用说明
|
||||
- **`assets/repos/prompts-library/`**: Excel ↔ Markdown 转换工具
|
||||
- **`assets/repos/chat-vault/`**: AI 聊天记录保存工具
|
||||
- **`assets/repos/backups/`**: 备份脚本与存档
|
||||
- **`tools/prompts-library/`**: Excel ↔ Markdown 转换工具
|
||||
- **`tools/chat-vault/`**: AI 聊天记录保存工具
|
||||
- **`scripts/backups/`**: 备份脚本与存档
|
||||
|
||||
### Key Technical Details
|
||||
1. **Prompt Organization**: 提示词使用 `(row,col)_` 前缀进行分类
|
||||
|
||||
Reference in New Issue
Block a user