Skip to content

docs(zh-CN): tasks #10 + #12 + #15 — Phase 4 domains consolidated + admin-guide + integration + web-access#1643

Merged
earayu merged 5 commits into
mainfrom
bryce/docs-zh-phase4-rewrite
Apr 24, 2026
Merged

docs(zh-CN): tasks #10 + #12 + #15 — Phase 4 domains consolidated + admin-guide + integration + web-access#1643
earayu merged 5 commits into
mainfrom
bryce/docs-zh-phase4-rewrite

Conversation

@earayu

@earayu earayu commented Apr 24, 2026

Copy link
Copy Markdown
Collaborator

Scope

This PR bundles Bryce lane docs for tasks #10 / #12 / #15 into a single PR cluster per PM msg=02b2be60 fast-merge directive. 6 docs landed, 1 more pending (user-guide/collection-marketplace.md for task #15).

Landed docs (6)

Task Doc LOC Purpose
#15 admin-guide/api-keys.md 118 API Key admin ops + governance/identity boundary rationale
#15 admin-guide/audit-log.md 130 AuditLog query + G15 literal-compare + UserView Protocol cross-ref
#15 admin-guide/quota-system.md 220 UserQuota + per-user limit/usage + system defaults + standalone-infra DI note
#12 integration/openai-compat.md 240 POST /chat/completions + stream SSE + SDK examples + incompat matrix
#12 architecture/web-access.md 244 web_access domain (no ORM, 2 sub-packages) + provider abstraction + /api/v2 prefix
#10 architecture/identity-governance-model-platform-marketplace.md 597 Phase 4 consolidated 4-domain architecture — identity/governance/model_platform/marketplace + G15/G16/G17 + legacy shim map

Total: 6 files / +1549 LOC / 0 deletion

Pending in Bryce lane (task #15)

  • user-guide/collection-marketplace.md (~500 LOC) — will land in follow-up commit on same branch

Discipline

Merge gate (per PM msg=02b2be60 + msg=f6370851)

  • Minimum review, no CI blocking, fast merge
  • Final full-corpus readthrough happens once all docs land per msg=f6370851

🤖 Generated with Claude Code

Bryce and others added 4 commits April 24, 2026 22:00
First doc in Bryce lane parallel claim (tasks #10/#11/#12/#15 per PM msg=eebfbd82).
Covers API Key admin operations: create/rotate/revoke/query + cross-domain
rationale (governance vs identity). Technical details cross-ref to
architecture/identity-governance-model-platform-marketplace.md.

Baseline: origin/main @ 10cabcf (post PR #1637 blueprint merge).

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
- admin-guide/audit-log.md: AuditLog ORM + query interfaces + G15 literal compare admin check + UserView Protocol cross-ref
- admin-guide/quota-system.md: UserQuota + per-user limit/usage + recalculate + system default + quota_service permanent DI seam note
- integration/openai-compat.md: POST /chat/completions endpoint + bot_id/chat_id/language query params + stream vs non-stream + SDK examples + known incompat

Per PM msg=dc3fa008 priority order audit-log -> quota-system -> openai-compat.
- web_access domain scope: no ORM, 2 sub-packages (search + reader)
- routes mounted at /api/v2 prefix (web/search + web/read)
- provider abstraction: DuckDuckGo/Jina (search), Trafilatura/Jina (read)
- soft-fail semantics on search; consumer list (KB document_service, MCP)
- local AuthenticatedUser Protocol (only id) — G16 honors
- Phase 2a hard-cut schema relocation + OpenAPI byte-stable note
…ace.md (task #10)

Consolidated 4-domain (Phase 4) architecture doc:
- identity: User/OAuthAccount/Role ORM + ports (AuthenticatedUser + 3 *InitOps) + UserManager.on_after_register + identity_user_ops (User write facade, lesson 9a-sexdec terminal)
- governance: ApiKey/AuditLog ORM + UserView Protocol + G15 literal-compare admin
- model_platform: LLMProvider/LLMProviderModel + 2-router split (llm_routes v1 + providers_v2)
- marketplace: CollectionMarketplace/UserCollectionSubscription + Q2 public rename check_marketplace_access

Cross-cutting: 14 per-domain AuthenticatedUser Protocol rationale, G15/G16/G17 gate catalog, Invitation class-body Role exception, G17=7 entries (3 identity adapters + 4 KB), legacy shim map (Phase 7+ candidates), cross-ref to SSoT docs/modularization/architecture.md.

Baseline: origin/main @ 28a9f53.
- user-guide/collection-marketplace.md (task #15): owner publish/unpublish + subscriber subscribe/unsubscribe + read-only access paths + permission matrix
- admin-guide/_category.yaml: title 管理指南 / position 4 (8-category IA per rewrite-plan Section 3)
- architecture/identity-governance-model-platform-marketplace.md: degrade Markdown link to ./indexing-retrieval-kg.md → plain code path + 起稿中 (Weston msg=450030a1 item 2, A-pattern per PR #1640)
- architecture/web-access.md: same link degrade

All Weston PR #1643 scoped IA fixes (msg=450030a1) applied. task #10 / #12 / #15 ready for merge per PM msg=73fc0969.
@earayu earayu marked this pull request as ready for review April 24, 2026 14:37
@earayu earayu merged commit c11b0ad into main Apr 24, 2026
3 checks passed
@earayu earayu deleted the bryce/docs-zh-phase4-rewrite branch April 24, 2026 14:38
earayu added a commit that referenced this pull request Apr 24, 2026
…1646)

Per PM task #18 + PR #1637 Section 4 triage + Bryce PR #1643 + huangheng PR #1644 both merged。

### 对应 target merge 完成触发的 Phase 2 delete
- `authentication.md` → task #10 `architecture/identity-governance-model-platform-marketplace.md` (PR #1643 `c11b0ad8`)
- `quota-system-design.md` → task #10 architecture + task #15 admin-guide (PR #1643)
- `collection_marketplace_design.md` → task #10 architecture + task #15 user-guide (PR #1643)
- `indexing_architecture.md` → task #11 `architecture/indexing-retrieval-kg.md` (PR #1644 `618b91a9`)
- `vector_db_abstraction.md` → task #11 (PR #1644)
- `search_flow_design.md` → task #11 (PR #1644)
- `vision_index_creation.md` → task #11 (PR #1644)
- `graph_curation.md` → task #11 (PR #1644)
- `graph_index_creation.md` → task #11 (PR #1644)
- `lightrag_entity_extraction_and_merging.md` → task #11 (PR #1644)
- `web-search-design.md` → task #12 `architecture/web-access.md` (PR #1643)

### 顺带清理
- `docs/zh-CN/design/_category.yaml` — design/ 目录现已空,category yaml 废弃一并删除

### task #18 完成状态
Phase 1 (PR #1642 `c75a739b`): en-US + web/docs + 22 source docs deleted
Phase 2 (本 PR): 最后 11 source docs + empty design/_category.yaml = 12 files

task #18 合入即可 → Done。

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
earayu added a commit that referenced this pull request Apr 24, 2026
…ker-image (3 docs) (#1645)

* docs(zh-CN): task #17 — integration/mcp + dify + deployment/build-docker-image (3 docs)

task #17 scope: 3 integration/deployment docs rewritten against factual baseline at origin/main c75a739.

- integration/mcp.md (NEW, 111 LOC): ApeRAG MCP Server 集成指南 — 架构、启用、认证、
  Claude Desktop/Cursor/Dify 客户端接入,工具速览。cross-ref 到 mcp-api.md (API 参考)
  与 docs/modularization/architecture.md。
- integration/dify.md (rewritten, 168 -> 183 LOC): Dify 通过 MCP 集成 ApeRAG 的完整
  工作流。修正了原版本里不存在的 create_diagram 工具引用;改为基于 5 个真实工具
  (list_collections / search_collection / search_chat_files / web_search / web_read) 的
  Prompt 模板。加 集成原理 section 明确 ApeRAG 没有 Dify-native 代码,完全基于 MCP。
- deployment/build-docker-image.md (rewritten, 49 -> 204 LOC): 构建指南扩展到涵盖镜像
  构成、前置条件、本地单平台、多平台 buildx、版本标签、Dockerfile 多阶段细节、前端
  独立 build 流程、Docker Compose profile、K8s helm 入口、CI release-image.yml workflow、
  常见问题。

* docs(zh-CN): task #17 — restore openai-compat Markdown link after PR #1643 merge
earayu added a commit that referenced this pull request Apr 24, 2026
…kg.md (Bryce readthrough fix-forward) (#1647)

task #11 (PR #1644) has merged, so the '起稿中' plain-text placeholders used at PR #1643 merge time can now be upgraded to live Markdown links.

- architecture/identity-governance-model-platform-marketplace.md: related docs list
- architecture/web-access.md: related docs list
- user-guide/collection-marketplace.md: inline KG reference

Per PM msg=e589830b owner-readthrough directive + msg=a60845be fix-forward discipline. No factual drift / no broken links / 0 scope expansion.
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