[docs][all] initialize AI coding harness docs#566
Merged
Conversation
xueyizheng
approved these changes
Jun 29, 2026
lizwang11
approved these changes
Jun 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
docs
Check the PR title
[docs][all] initialize AI coding harness with AGENTS.md and architecture docs(Optional) Translate the PR title into Chinese
[docs][all] 初始化 AI 编码辅助文档体系(AGENTS.md 及架构文档)
(Optional) More detailed description for this PR
en:
Add the AI coding harness documentation to help AI assistants (e.g., Claude Code, Cursor) understand and navigate this repository effectively. This includes:
AGENTS.md: top-level entry point with project overview, core constraints, dev workflow, and common commandsARCHITECTURE.md: system architecture, code map, and dependency invariantsai-package.json: AI package metadatadocs/AGENTS.md: mid-level index linking reference and guidance docsdocs/reference/backend-modules-api.md: backend 6 DDD modules responsibility and API routesdocs/reference/frontend-packages.md: frontend 59 packages layered structuredocs/guidance/deployment-guide.md: Docker Compose / Helm deployment guidedocs/guidance/idl-codegen-guide.md: IDL change and codegen workflowzh(optional):
为仓库添加 AI 编码辅助文档体系,帮助 AI 编码助手高效理解和导航本仓库。包括项目入口文档 AGENTS.md、架构文档 ARCHITECTURE.md、后端模块 API 参考、前端包分层参考、部署指南和 IDL 代码生成指南。
(Optional) Which issue(s) this PR fixes
N/A