Skip to content

docs(zh-CN): Phase 5/6 body rewrite — task #9 + #14 (5 docs)#1641

Merged
earayu merged 2 commits into
mainfrom
chenyexuan/docs-zh-phase56
Apr 24, 2026
Merged

docs(zh-CN): Phase 5/6 body rewrite — task #9 + #14 (5 docs)#1641
earayu merged 2 commits into
mainfrom
chenyexuan/docs-zh-phase56

Conversation

@earayu
Copy link
Copy Markdown
Collaborator

@earayu earayu commented Apr 24, 2026

Summary

Body-rewrite PR cluster for task #9 (architecture/conversation-agent-evaluation.md consolidated) + task #14 (admin-guide/prompt-customization + user-guide/evaluation-guide + user-guide/chat-interaction + reference/prompt-api) per PM msg=a7d9f216 并行自启动口径。

Baseline: origin/main @ 10cabcf (PR #1637 rewrite-plan merged).

5 new docs (785 LOC total)

Path LOC 来源
docs/zh-CN/architecture/conversation-agent-evaluation.md 288 按 task #7 batch 2 5-section skeleton 实装;融合 agent_runtime_v3 + chat_history_design + evaluation-design + prompt_customization_design 架构段
docs/zh-CN/admin-guide/prompt-customization.md 131 新增;prompt_customization_design.md 用户/管理面剥出
docs/zh-CN/user-guide/evaluation-guide.md 138 MOVE + minor from reference/evaluation-current-guide.md
docs/zh-CN/user-guide/chat-interaction.md 82 新增(blueprint Section 5.2 chenyexuan 主笔)
docs/zh-CN/reference/prompt-api.md 146 REWRITE from prompt_customization_api_test.md;SK → 占位 + 规范化

Cross-reference 惯例

所有 architecture 相关 canonical invariant(import path aperag.domains.* / Protocol / CRITICAL_WIRINGS / G-gates)通过 hyperlink 指向 docs/modularization/architecture.md 对应 section,不重复 copy 定义(架构师 msg=aee91f5b + rewrite-plan §3 lock)。

Scope boundary

  • 新增 5 docs;不删任何旧 design doc 或 reference 源(删除归 task feat: auto size for chat input #18 机械批次)
  • 不改任何代码
  • 不改 docs/modularization/**(PM msg=5286eb6a lock)

Review lane

按 PM msg=ecf95bbe review 分工延续:

  • Phase 5/6 本身:PR 内容就是 Phase 5/6 scope
  • 架构 canonical consistency:@符炫炜(cross-ref 到 architecture.md 是否一致)
  • cross-domain boundary spot-check:@huangheng / @bryce / @cuiwenbo 各自 Phase 4/3 / getting-started 主笔 PR 内同等机会互查

CR cadence

draft 状态;若 reviewer 有 substantive factual correction,thread reply,我 inline 改。没有新 issue 则 mark ready 进 PM merge gate。

🤖 Generated with Claude Code

earayu and others added 2 commits April 24, 2026 22:08
PM msg=a7d9f216 正文并行自启动指令;task #9 (architecture/conversation-agent-evaluation.md) + task #14 (admin-guide/prompt-customization.md + user-guide/evaluation-guide.md + user-guide/chat-interaction.md + reference/prompt-api.md) 合一 PR cluster 提交。

Baseline: origin/main @ 10cabcf (PR #1637 rewrite-plan merged)。全部按 rewrite-plan.md Section 4/5 / 5.1/5.3/5.5 新 IA 位置 + Section 3 cross-reference 惯例(link to docs/modularization/architecture.md 不重复 canonical 定义)。

- architecture/conversation-agent-evaluation.md (~288 LOC): conversation+agent_runtime+evaluation 三域 consolidated 架构文档;按 task #7 batch 2 (msg=ed99fef3) 5-section skeleton 实装。覆盖:三域边界 / conversation 6-services topology / agent_runtime Turn 生命周期 + PromptTemplateOps DI seam / evaluation worker state machine + is_terminal() classmethod + dispatch_fn test-injection seam / 跨三域 runtime flow。
- admin-guide/prompt-customization.md (~131 LOC): prompt 三层优先级覆盖 UX + Bot/Collection/User 三层配置 + 常见排查 + standalone-infra service 归属说明。
- user-guide/evaluation-guide.md (~138 LOC): MOVE from reference/evaluation-current-guide.md + canonical home 引用 + is_terminal() classmethod 边界说明。
- user-guide/chat-interaction.md (~82 LOC): 新增;面向用户的 chat + Bot + Turn 生命周期 + Agent 能力说明。
- reference/prompt-api.md (~146 LOC): REWRITE from prompt_customization_api_test.md;SK 改占位 sk-<your-api-key> + cross-ref 到 admin-guide + architecture。

旧源文档(agent_runtime_v3.md / agent-backend.md / chat_history_design.md / evaluation-design.md / prompt_customization_design.md / prompt_customization_integration_todo.md / prompt_customization_api_test.md / reference/evaluation-current-guide.md)的删除归 task #18 机械批次;本 PR 只新增 5 doc 不删旧 source。

Total: 5 files / +785 LOC / 0 deletion.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…in text

Per PM msg=83fc6b21 Weston Option A precedent (PR #1640):pre-emptive alignment with new-IA category conventions, avoid review round-trip.

- Add docusaurus-style front-matter (title + position) to all 5 docs so 中文 docs site 排序正常
- chat-interaction.md: 2 forward cross-ref (integration/mcp.md + admin-guide/quota-system.md) downgraded from Markdown link to plain code path — 这 2 个目标 doc 归属 task #17 / Bryce task #15,尚未起 draft,防止 docs 站点 broken link

Front-matter positions 按 blueprint 8-IA category 顺序分配:
- architecture/conversation-agent-evaluation.md: position=34(architecture 类中 overview=10/domains=20/indexing-retrieval-kg=32/conversation-agent-evaluation=34/identity-governance-model-platform-marketplace=36/web-access=38)
- user-guide/evaluation-guide.md: position=50
- user-guide/chat-interaction.md: position=40
- admin-guide/prompt-customization.md: position=50
- reference/prompt-api.md: position=20

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@earayu earayu marked this pull request as ready for review April 24, 2026 14:19
@earayu earayu merged commit 003073b into main Apr 24, 2026
3 checks passed
@earayu earayu deleted the chenyexuan/docs-zh-phase56 branch April 24, 2026 14:21
earayu added a commit that referenced this pull request Apr 24, 2026
… 22 obsolete zh-CN source docs (#1642)

Per PM task #18 msg=5f300de5 + user msg=f3051291 scope lock + PR #1637 Section 4 triage matrix:

### docs/en-US/** 全删 (~30 files)
Per user msg=f3051291 "英文文档可以全部删除"。全量移除 en-US 目录。

### web/docs/** 全删 (~16 files)
Per user msg=f3051291 "Web 中的文档可以全部删除"。全量移除 web/docs 目录(含 en-US + zh-CN 镜像)。

### docs/zh-CN/ 废弃 source docs (22 files)

blueprint PR #1637 Section 4 triage matrix 标 DELETE 或已 MERGE 到 consolidated target 的 source docs。此 Phase 1 batch 只删已对应 target merge 完成的 source(task #8/#9/#13/#14/#16 对应 source + unconditional DELETE items);Phase 2 将在 Bryce task #10/#11/#12/#15 merge 后补删其 source docs。

**DELETE-only (历史/过程 doc 无对应 consolidated target)**:
- agent-backend.md (superseded by agent_runtime_v3.md → conversation-agent-evaluation.md task #9)
- connected_components_optimization.md (历史优化 log)
- graph_db_abstraction.md (M1-M3 已落地设计文档)
- graph_normalization_merge_full_analysis.md (历史 audit)
- graphindex_rewrite.md (重构 log)
- lightrag_refactor.md (重构计划)
- prompt_customization_integration_todo.md (TODO 已全部 shipped)
- qdrant_memory_optimization.md (运营历史优化)
- tag_based_permission_design.md (feature 未实装 per Bryce grep-verify + PM msg=4a73b5a4 lock)
- vector_db_abstraction_m2_pr.md (PR 过程 doc)
- vector_db_abstraction_m3_pr.md (PR 过程 doc)

**MERGE 已完成 (target task 已 merge)**:
- architecture.md → architecture/overview.md + domains.md (task #8 PR #1640 merged)
- agent_runtime_v3.md → architecture/conversation-agent-evaluation.md (task #9 PR #1641 merged)
- chat_history_design.md → architecture/conversation-agent-evaluation.md (task #9 PR #1641)
- evaluation-design.md → architecture/conversation-agent-evaluation.md (task #9 PR #1641)
- prompt_customization_design.md → architecture/conversation-agent-evaluation.md + admin-guide/prompt-customization.md (task #9+#14)
- prompt_customization_api_test.md → reference/prompt-api.md (task #14 PR #1641)
- url_and_text_import_design.md → user-guide/content-import.md (task #13 PR #1638 merged)
- document_upload_design.md → user-guide/document-upload.md + architecture/indexing-retrieval-kg.md (task #13 user-facing part merged; architecture part pending Bryce task #11)
- collection_knowledge_export_design.md → user-guide/knowledge-export.md (task #13 PR #1638 merged)
- reference/evaluation-current-guide.md → user-guide/evaluation-guide.md (task #16 MOVE merged)
- reference/how-to-configure-ollama.md → deployment/llm-providers-ollama.md (task #16 MOVE merged)

### 未删除 (Phase 2 pending Bryce task #10/#11/#12/#15 merge)

以下 source docs 对应 Bryce 正文任务仍未 merge,保留至 Phase 2:
- authentication.md (→ task #10)
- quota-system-design.md (→ task #10 + task #15)
- collection_marketplace_design.md (→ task #10 + task #15)
- indexing_architecture.md / vector_db_abstraction.md / search_flow_design.md / vision_index_creation.md / graph_curation.md / graph_index_creation.md / lightrag_entity_extraction_and_merging.md (→ task #11)
- web-search-design.md (→ task #12)

### Scope discipline
- docs/modularization/** 保留 (per PM msg=5286eb6a)
- README* 保留 (per user msg=f3051291)
- docs/zh-CN/rewrite-plan.md 保留 (task #4 deliverable)
- docs/zh-CN/reference/HOW-TO-DEBUG.md 保留 (task #16 KEEP)
- integration/mcp-api.md + integration/dify.md + deployment/build-docker-image.md + development/development-guide.md 保留 (task #17 + task #8 分别处理)

**Summary**: 113 files changed, 27713 deletions, 0 additions。

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
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