From 2fe2312164c7980991050d0ae7cd1fa128cc0f99 Mon Sep 17 00:00:00 2001 From: tukuaiai Date: Thu, 26 Feb 2026 08:41:01 +0800 Subject: [PATCH] docs: readme/agents - sync paths --- AGENTS.md | 36 ++++++++++++++++-------------------- README.md | 24 ++++++++++-------------- 2 files changed, 26 insertions(+), 34 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 94fb1e4..0f821b3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,7 +7,7 @@ ## 1. Mission & Scope（目标与边界） ### 允许的操作 -- 读取、修改顶层文档：`README.md`、`AGENTS.md`、`CLAUDE.md`、`GEMINI.md` 等 +- 读取、修改顶层文档：`README.md`、`AGENTS.md`、`CONTRIBUTING.md` 等 - 读取、修改 `documents/`、`prompts/`、`skills/`、`workflow/`、`config/`、`tools/`、`repo/` 下的文档与代码 - 执行 `make lint`、备份脚本、prompts-library 转换工具 - 新增/修改提示词、技能、文档 @@ -15,14 +15,14 @@ ### 禁止的操作 - 修改 `.github/workflows/` 中的 CI 配置（除非任务明确要求） -- 删除或覆盖 `backups/gz/` 中的存档文件 +- 删除或覆盖 `repo/backups/gz/` 中的存档文件 - 修改 `LICENSE`、`CODE_OF_CONDUCT.md` - 在代码中硬编码密钥、Token 或敏感凭证 - 未经确认的大范围重构 ### 敏感区域（禁止自动修改） - `.github/workflows/*.yml` - CI/CD 配置 -- `backups/gz/` - 历史备份存档 +- `repo/backups/gz/` - 历史备份存档 - `.env*` 文件（如存在） --- @@ -63,8 +63,8 @@ git push origin develop |:---|:---|:---| | `make help` | 列出所有 Make 目标 | 无 | | `make lint` | 校验全仓库 Markdown | 需安装 markdownlint-cli | -| `bash backups/一键备份.sh` | 创建完整项目备份 | 无 | -| `python3 backups/快速备份.py` | Python 版备份脚本 | Python 3.8+ | +| `bash repo/backups/一键备份.sh` | 创建完整项目备份 | 无 | +| `python3 repo/backups/快速备份.py` | Python 版备份脚本 | Python 3.8+ | | `cd repo/prompts-library && python3 main.py` | 提示词格式转换 | pandas, openpyxl, PyYAML | ### prompts-library 支持的转换模式 @@ -130,14 +130,16 @@ git push origin develop . ├── README.md # 项目主文档 ├── AGENTS.md # AI Agent 行为准则（本文件） -├── CLAUDE.md # Claude 模型上下文（合并在本文件末尾） -├── GEMINI.md # Gemini 模型上下文 ├── Makefile # 自动化脚本 ├── LICENSE # MIT 许可证 ├── CODE_OF_CONDUCT.md # 行为准则 ├── CONTRIBUTING.md # 贡献指南 ├── .gitignore # Git 忽略规则 │ +├── assets/ # 外部资源（指向在线表格） +│ ├── README.md # 远程表格索引（唯一真相源） +│ └── AGENTS.md # assets/ 目录规则 +│ ├── config/ # 工具与开发配置 │ └── .codex/ # Codex CLI 配置（项目级） │ ├── config.toml # Codex CLI 配置文件 @@ -197,19 +199,13 @@ git push origin develop │ ├── tools/ # 工具目录（预留） │ └── .gitkeep # 保持空目录被 Git 追踪 -│ -└── backups/ # 备份脚本与存档 - ├── 一键备份.sh # Shell 备份脚本 - ├── 快速备份.py # Python 备份脚本 - ├── README.md # 备份说明 - └── gz/ # 压缩存档目录 ``` ### 关键入口文件 - `README.md` - 项目主文档，面向人类开发者 - `AGENTS.md` - AI Agent 操作手册（本文件） - `repo/prompts-library/main.py` - 提示词转换工具入口 -- `backups/一键备份.sh` - 备份脚本入口 +- `repo/backups/一键备份.sh` - 备份脚本入口 - `skills/tmux-autopilot/` - tmux 自动化操控技能（基于 oh-my-tmux，含 capture-pane/send-keys/蜂群巡检脚本） - `skills/sop-generator/` - SOP 生成与规范化技能（输入资料/需求 -> 标准 SOP） @@ -221,8 +217,9 @@ git push origin develop |:---|:---|:---| | `make lint` 失败 | 未安装 markdownlint-cli | `npm install -g markdownlint-cli` | | prompts-library 报错 | 缺少 Python 依赖 | `pip install pandas openpyxl PyYAML rich InquirerPy` | +| CI markdown-lint 失败 | `.github/lint_config.json` 缺失 | TODO：新增 `.github/lint_config.json` 或调整 `.github/workflows/ci.yml` 的 lint 命令（需任务明确授权） | | CI link-checker 失败 | 文档中存在失效链接 | 检查并修复 Markdown 中的链接 | -| 备份脚本权限不足 | Shell 脚本无执行权限 | `chmod +x backups/一键备份.sh` | +| 备份脚本权限不足 | Shell 脚本无执行权限 | `chmod +x repo/backups/一键备份.sh` | --- @@ -264,13 +261,12 @@ feat|fix|docs|chore|refactor|test: scope - summary **任何功能/命令/配置/目录/工作流变化必须同步更新：** - `README.md` - 面向人类开发者 - `AGENTS.md` - 面向 AI Agent（本文件） -- `GEMINI.md` - Gemini 模型上下文 **不确定的内容用 TODO 标注，不允许猜测。** --- -# CLAUDE.md +# Claude 上下文（合并在本文件） 本节为 Claude 系列模型提供项目上下文。 @@ -288,7 +284,7 @@ cd repo/prompts-library && python3 main.py make lint # 创建完整项目备份 -bash backups/一键备份.sh +bash repo/backups/一键备份.sh ``` ## Architecture & Structure @@ -299,7 +295,7 @@ bash backups/一键备份.sh - **`documents/`**: 知识库（05-哲学与方法论、00-基础指南、01-入门指南、02-方法论、03-实战、04-资源） - **`repo/prompts-library/`**: Excel ↔ Markdown 转换工具 - **`repo/chat-vault/`**: AI 聊天记录保存工具 -- **`backups/`**: 备份脚本与存档 +- **`repo/backups/`**: 备份脚本与存档 ### Key Technical Details 1. **Prompt Organization**: 提示词使用 `(row,col)_` 前缀进行分类 @@ -316,7 +312,7 @@ bash backups/一键备份.sh --- -# GEMINI.md - 项目上下文文档 +# Gemini 上下文（合并在本文件） ## 项目概述 diff --git a/README.md b/README.md index b5aab4b..6a62a5f 100644 --- a/README.md +++ b/README.md @@ -368,14 +368,16 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 . ├── README.md # 项目主文档 ├── AGENTS.md # AI Agent 行为准则 -├── CLAUDE.md # Claude 模型上下文 -├── GEMINI.md # Gemini 模型上下文 ├── Makefile # 自动化脚本 ├── LICENSE # MIT 许可证 ├── CODE_OF_CONDUCT.md # 行为准则 ├── CONTRIBUTING.md # 贡献指南 ├── .gitignore # Git 忽略规则 │ +├── assets/ # 外部资源（指向在线表格） +│ ├── README.md # 远程表格索引（唯一真相源） +│ └── AGENTS.md # assets/ 目录规则 +│ ├── config/ # 工具与开发配置 │ └── .codex/ # Codex CLI 配置（项目级） │ ├── config.toml # Codex CLI 配置文件 @@ -434,12 +436,6 @@ Canvas方式：**代码 ⇄ 白板 ⇄ AI ⇄ 人类**，白板成为单一真 │ ├── tools/ # 工具目录（预留） │ └── .gitkeep # 保持空目录被 Git 追踪 -│ -└── backups/ # 备份脚本与存档 - ├── 一键备份.sh # Shell 备份脚本 - ├── 快速备份.py # Python 备份脚本 - ├── README.md # 备份说明 - └── gz/ # 压缩存档目录 ``` @@ -469,7 +465,7 @@ prompts/ 03-用户提示词/ # 可复用的用户侧提示词 documents/ 04-资源/代码组织.md, 04-资源/通用项目架构模板.md, 00-基础指南/开发经验.md, 00-基础指南/系统提示词构建原则.md 等知识库 -backups/ +repo/backups/ 一键备份.sh, 快速备份.py # 本地/远端快照脚本 ``` @@ -490,8 +486,8 @@ graph TB subgraph ingest_layer[数据接入与采集层] excel_raw[prompt_excel/*.xlsx] md_raw[prompt_docs/外部MD输入] - excel_to_docs[prompts-library/scripts/excel_to_docs.py] - docs_to_excel[prompts-library/scripts/docs_to_excel.py] + excel_to_docs[repo/prompts-library/scripts/excel_to_docs.py] + docs_to_excel[repo/prompts-library/scripts/docs_to_excel.py] ingest_bus[标准化数据帧] ext_sheet --> excel_raw ext_md --> md_raw @@ -529,9 +525,9 @@ graph TB subgraph infra_layer[基础设施与横切能力层] git[Git 版本控制] --> orchestrator - backups[backups/一键备份.sh · backups/快速备份.py] --> artifacts_md + backups[repo/backups/一键备份.sh · repo/backups/快速备份.py] --> artifacts_md deps[requirements.txt · scripts/requirements.txt] --> orchestrator - config[prompts-library/scripts/config.yaml] --> orchestrator + config[repo/prompts-library/scripts/config.yaml] --> orchestrator monitor[预留：日志与监控] --> orchestrator end ``` @@ -613,7 +609,7 @@ gantt
-2. 技术栈与 CLAUDE.md / AGENTS.md +2. 技术栈与 Agent 规则（AGENTS.md / 自定义 rules） - 让 **gpt-5.3-codex** 或 **Claude Opus 4.6** 为你的游戏推荐最合适的技术栈（例如：多人3D游戏用 ThreeJS + WebSocket），保存为 `tech-stack.md`。 - 要求它提出 **最简单但最健壮** 的技术栈。