File Placement Rules
🚨 ZERO TOLERANCE FILE PLACEMENT 🚨
STRICT RULES
- * ❌ FORBIDDEN: Creating .md files in
/Users/tobymorning/Desktop/core/ (except README.md, CLAUDE.md) - ❌ FORBIDDEN: Creating .md files in
/Users/tobymorning/Desktop/core/src/backend/ (except README.md) - ❌ FORBIDDEN: Creating .md files in
/Users/tobymorning/Desktop/core/AINative-website/ (except README.md, CLAUDE.md) - ❌ FORBIDDEN: Creating scripts (.sh) in
/Users/tobymorning/Desktop/core/src/backend/ (except start.sh)
REQUIRED LOCATIONS
Backend Documentation → /Users/tobymorning/Desktop/core/docs/
- * Issues/Bugs:
docs/issues/ISSUE_*.md, docs/issues/BUG_*.md, INLINECODE7 - Testing/QA:
docs/testing/*_TEST*.md, INLINECODE9 - Agent Swarm:
docs/agent-swarm/AGENT_SWARM_*.md, docs/agent-swarm/WORKFLOW_*.md, INLINECODE12 - API Documentation:
docs/api/API_*.md, INLINECODE14 - Implementation Reports:
docs/reports/*_IMPLEMENTATION*.md, INLINECODE16 - Deployment:
docs/deployment/DEPLOYMENT_*.md, INLINECODE18 - Quick References:
docs/quick-reference/*_QUICK_*.md, docs/quick-reference/*_REFERENCE.md, INLINECODE21 - Backend Features:
docs/backend/RLHF_*.md, docs/backend/MEMORY_*.md, INLINECODE24 - Development Guides:
docs/development-guides/CODING_*.md, docs/development-guides/*_GUIDE.md, INLINECODE27 - Planning:
docs/planning/PRD_*.md, INLINECODE29
Frontend Documentation → /Users/tobymorning/Desktop/core/AINative-website/docs/
- * Frontend Features: INLINECODE31
- Frontend Testing: INLINECODE32
- Frontend Implementation: INLINECODE33
- Frontend Issues: INLINECODE34
- Frontend Deployment: INLINECODE35
- Frontend Reports: INLINECODE36
Scripts → /Users/tobymorning/Desktop/core/scripts/
- * ALL test scripts: INLINECODE38
- ALL migration scripts: INLINECODE39
- ALL monitoring scripts: INLINECODE40
- ALL utility scripts: INLINECODE41
ENFORCEMENT WORKFLOW
Before creating ANY .md file or .sh script, you MUST:
- 1. ✅ Check if you're creating it in a root directory
- ✅ If yes, STOP and use the appropriate docs/ or scripts/ subfolder
- ✅ Choose the correct category based on filename patterns above
- ✅ Create in the correct location FIRST TIME, not in root then move later
VIOLATION CONSEQUENCES
Creating documentation in root directories causes:
- * Project clutter and disorganization
- Wasted time reorganizing files
- Inconsistent documentation structure
- Developer frustration
- Loss of findability for important docs
THIS IS A ZERO-TOLERANCE RULE. ALWAYS use docs/ or scripts/ subfolders.
Reference Files
See references/directory-mapping.md for complete mapping table of filename patterns to required directory locations.
文件放置规则
🚨 零容忍文件放置 🚨
严格规则
- * ❌ 禁止: 在 /Users/tobymorning/Desktop/core/ 中创建 .md 文件(README.md、CLAUDE.md 除外)
- ❌ 禁止: 在 /Users/tobymorning/Desktop/core/src/backend/ 中创建 .md 文件(README.md 除外)
- ❌ 禁止: 在 /Users/tobymorning/Desktop/core/AINative-website/ 中创建 .md 文件(README.md、CLAUDE.md 除外)
- ❌ 禁止: 在 /Users/tobymorning/Desktop/core/src/backend/ 中创建脚本(.sh 文件)(start.sh 除外)
必需位置
后端文档 → /Users/tobymorning/Desktop/core/docs/
- 问题/缺陷: docs/issues/ISSUE.md、docs/issues/BUG.md、docs/issues/ROOTCAUSE.md
- 测试/质量保证: docs/testing/TEST.md、docs/testing/QA.md
- 智能体集群: docs/agent-swarm/AGENTSWARM.md、docs/agent-swarm/WORKFLOW.md、docs/agent-swarm/STAGE.md
- API 文档: docs/api/API.md、docs/api/ENDPOINTS.md
- 实施报告: docs/reports/IMPLEMENTATION.md、docs/reports/SUMMARY.md
- 部署: docs/deployment/DEPLOYMENT.md、docs/deployment/RAILWAY.md
- 快速参考: docs/quick-reference/QUICK.md、docs/quick-reference/REFERENCE.md、docs/quick-reference/STEPS.md
- 后端功能: docs/backend/RLHF.md、docs/backend/MEMORY.md、docs/backend/SECURITY.md
- 开发指南: docs/development-guides/CODING.md、docs/development-guides/GUIDE.md、docs/guides/INSTRUCTIONS.md
- 规划: docs/planning/PRD_.md、docs/planning/BACKLOG.md
前端文档 → /Users/tobymorning/Desktop/core/AINative-website/docs/
- * 前端功能: AINative-website/docs/features/
- 前端测试: AINative-website/docs/testing/
- 前端实施: AINative-website/docs/implementation/
- 前端问题: AINative-website/docs/issues/
- 前端部署: AINative-website/docs/deployment/
- 前端报告: AINative-website/docs/reports/
脚本 → /Users/tobymorning/Desktop/core/scripts/
- 所有测试脚本: scripts/test.sh
- 所有迁移脚本: scripts/migration.sh
- 所有监控脚本: scripts/monitor_.sh
- 所有工具脚本: scripts/*.sh
执行工作流程
在创建任何 .md 文件或 .sh 脚本之前,你必须:
- 1. ✅ 检查是否在根目录中创建
- ✅ 如果是,停止并使用相应的 docs/ 或 scripts/ 子文件夹
- ✅ 根据上述文件名模式选择正确的类别
- ✅ 首次即创建在正确位置,而非先放根目录再移动
违规后果
在根目录创建文档会导致:
- * 项目杂乱无章
- 浪费时间重新组织文件
- 文档结构不一致
- 开发人员受挫
- 重要文档难以查找
此为零容忍规则。始终使用 docs/ 或 scripts/ 子文件夹。
参考文件
参见 references/directory-mapping.md 获取文件名模式到必需目录位置的完整映射表。