Skip to content

docs: 统一 AI 助理文档为单一来源(AGENTS.md 正文,CLAUDE.md 导入)#198

Merged
g1331 merged 1 commit into
masterfrom
docs/single-source-agent-docs
May 30, 2026
Merged

docs: 统一 AI 助理文档为单一来源(AGENTS.md 正文,CLAUDE.md 导入)#198
g1331 merged 1 commit into
masterfrom
docs/single-source-agent-docs

Conversation

@g1331
Copy link
Copy Markdown
Owner

@g1331 g1331 commented May 30, 2026

Summary

将 CLAUDE.md 与 AGENTS.md 合并为单一来源:AGENTS.md 承载完整正文,CLAUDE.md 通过 @AGENTS.md 导入,避免两份文档随时间分叉。Claude Code 读 CLAUDE.md 经导入获得正文,其他 AI 工具(OpenAI Codex、Cursor、Gemini CLI、GitHub Copilot 等)直接读 AGENTS.md,内容始终一致。

Change type

  • docs

Changes

  • AGENTS.md 升级为面向所有 AI 工具的单一正文,整合 Project Overview、Development Commands、Architecture、Configuration、Docker、Code Quality & CI、Coding Style & Naming、Testing、Commit & PR、Working Conventions、Common Development Tasks。
  • 修正文档与代码的偏差:admin 目录补充 health/upstream-failure-rules/,区分 traffic-recording/traffic-recordings/,补充 docs:preview 命令,翻译文件名统一为 zh-CN.json,移除 services/ 的 "see below" 悬挂引用。
  • CLAUDE.md 精简为薄壳,通过 @AGENTS.md 导入正文。

Test plan

  • pnpm exec prettier --check AGENTS.md CLAUDE.md
  • pre-commit(prettier / eslint --fix / tsc --noEmit / 通用钩子)随提交执行并通过。

Checklist

  • 文档改动
  • 未跳过 pre-commit

@g1331 g1331 merged commit d8092ad into master May 30, 2026
12 checks passed
@g1331 g1331 deleted the docs/single-source-agent-docs branch May 30, 2026 16:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant