From 1a1aa5983894b5abe3d6f78e845ce376e97e7053 Mon Sep 17 00:00:00 2001 From: jxxghp Date: Fri, 11 Sep 2026 06:20:59 +0800 Subject: [PATCH] docs(architecture): move refactor documents --- docs/architecture-overview.md | 6 +++--- docs/mcp-api.md | 2 +- .../{architecture => refactor}/agent-api-surface-audit.json | 0 docs/{architecture => refactor}/agent-api-surface-audit.md | 0 docs/{architecture => refactor}/agent-tool-refactor-plan.md | 2 +- docs/{architecture => refactor}/optimization-checklist.md | 0 docs/{architecture => refactor}/refactor-roadmap.md | 0 .../subscription-search-review.md | 0 docs/subscribe-lifecycle.md | 2 +- scripts/generate_agent_api_surface_audit.py | 4 ++-- skills/moviepilot-api/SKILL.md | 2 +- tests/test_agent_api_surface_audit.py | 4 ++-- tests/test_architecture_contract_baseline.py | 4 ++-- 13 files changed, 13 insertions(+), 13 deletions(-) rename docs/{architecture => refactor}/agent-api-surface-audit.json (100%) rename docs/{architecture => refactor}/agent-api-surface-audit.md (100%) rename docs/{architecture => refactor}/agent-tool-refactor-plan.md (99%) rename docs/{architecture => refactor}/optimization-checklist.md (100%) rename docs/{architecture => refactor}/refactor-roadmap.md (100%) rename docs/{architecture => refactor}/subscription-search-review.md (100%) diff --git a/docs/architecture-overview.md b/docs/architecture-overview.md index 4f108f513..beeb0cd90 100644 --- a/docs/architecture-overview.md +++ b/docs/architecture-overview.md @@ -802,7 +802,7 @@ flowchart LR 保留多余导出。 当前架构问题、优先级、分阶段实施步骤与验收门禁见 -[`docs/architecture/optimization-checklist.md`](architecture/optimization-checklist.md)。 +[`docs/refactor/optimization-checklist.md`](refactor/optimization-checklist.md)。 --- @@ -818,7 +818,7 @@ flowchart LR | [`docs/rules/10-data-and-persistent.md`](rules/10-data-and-persistent.md) | 数据模型、迁移与缓存规范 | | [`docs/subscribe-lifecycle.md`](subscribe-lifecycle.md) | 订阅生命周期详解 | | [`docs/mcp-api.md`](mcp-api.md) | MCP 工具端点说明 | -| [`docs/architecture/optimization-checklist.md`](architecture/optimization-checklist.md) | 当前架构差距、优先级与可执行优化清单 | -| [`docs/architecture/refactor-roadmap.md`](architecture/refactor-roadmap.md) | 多级 Goal、叶子依赖、清零条件与交付状态 | +| [`docs/refactor/optimization-checklist.md`](refactor/optimization-checklist.md) | 当前架构差距、优先级与可执行优化清单 | +| [`docs/refactor/refactor-roadmap.md`](refactor/refactor-roadmap.md) | 多级 Goal、叶子依赖、清零条件与交付状态 | | [`docs/v3t-runtime-governance.md`](v3t-runtime-governance.md) | V3/V3t 运行依赖、故障恢复、GIL 可观测性与兼容退场门禁 | | [`docs/adr/0007-background-action-reliability.md`](adr/0007-background-action-reliability.md) | 后台动作 E0–E3 可靠性分级与完成语义决策 | diff --git a/docs/mcp-api.md b/docs/mcp-api.md index ec82ef4d2..3e30a4dda 100644 --- a/docs/mcp-api.md +++ b/docs/mcp-api.md @@ -76,7 +76,7 @@ MCP 当前不会主动发送工具列表变更通知（`listChanged=false`）。 | `stream_or_binary` | 10 | 由直接客户端处理流式日志、消息、文件、图片等非结构化响应 | | `ui_presentation` | 15 | 由前端或插件渲染面拥有，不作为业务 Agent operation | -逐路由归属见 `docs/architecture/agent-api-surface-audit.md`，并由 +逐路由归属见 `docs/refactor/agent-api-surface-audit.md`，并由 `tests/test_agent_api_surface_audit.py` 对当前 OpenAPI、固定注册表、MCP schema、英文 Skill 合同及全部非网关归属做漂移检查。任何新增端点必须先明确归属；对 Agent 开放时还必须补齐 operation ID、权限、副作用、确认、恢复、结果敏感性及精确参数说明。 diff --git a/docs/architecture/agent-api-surface-audit.json b/docs/refactor/agent-api-surface-audit.json similarity index 100% rename from docs/architecture/agent-api-surface-audit.json rename to docs/refactor/agent-api-surface-audit.json diff --git a/docs/architecture/agent-api-surface-audit.md b/docs/refactor/agent-api-surface-audit.md similarity index 100% rename from docs/architecture/agent-api-surface-audit.md rename to docs/refactor/agent-api-surface-audit.md diff --git a/docs/architecture/agent-tool-refactor-plan.md b/docs/refactor/agent-tool-refactor-plan.md similarity index 99% rename from docs/architecture/agent-tool-refactor-plan.md rename to docs/refactor/agent-tool-refactor-plan.md index 02f9bbbc8..abb77953c 100644 --- a/docs/architecture/agent-tool-refactor-plan.md +++ b/docs/refactor/agent-tool-refactor-plan.md @@ -320,7 +320,7 @@ action，并使用 MoviePilot 已配置的具体服务实例访问其自身 API - Ruff 低水位由 576 降至 574，mypy 低水位由 9,606 降至 9,605；mypy、复杂度 v1/v2、并发、异步阻塞、TaskRegistry owner、服务定位和启动性能全部本地通过 - API/Skill/MCP/provider 专项 86 passed，架构与质量门禁专项 127 passed；生成器重建后工作区合同无额外差异 - 第三次推送 `e5722ed98` 的远端 Pylint 成功；Unit Tests 的功能分片与覆盖率分片均通过，但 Architecture Contract Gate 在文档合同测试中发现优化清单仍写着旧的 `9,606 / 576` 量化指标 -- 已将 `docs/architecture/optimization-checklist.md` 同步为 `9,605 / 574`，本地 `test_architecture_contract_baseline.py` 与 `test_architecture_baseline_cli.py` 共 45 项通过，并确认 `baseline.py --check-host` 成功 +- 已将 `docs/refactor/optimization-checklist.md` 同步为 `9,605 / 574`，本地 `test_architecture_contract_baseline.py` 与 `test_architecture_baseline_cli.py` 共 45 项通过，并确认 `baseline.py --check-host` 成功 - 当前活动叶子保持 L9；下一步提交文档指标修复，等待所有远端工作流终态成功后更新为 COMPLETE ### 2026-08-31：最终提交与远端门禁完成 diff --git a/docs/architecture/optimization-checklist.md b/docs/refactor/optimization-checklist.md similarity index 100% rename from docs/architecture/optimization-checklist.md rename to docs/refactor/optimization-checklist.md diff --git a/docs/architecture/refactor-roadmap.md b/docs/refactor/refactor-roadmap.md similarity index 100% rename from docs/architecture/refactor-roadmap.md rename to docs/refactor/refactor-roadmap.md diff --git a/docs/architecture/subscription-search-review.md b/docs/refactor/subscription-search-review.md similarity index 100% rename from docs/architecture/subscription-search-review.md rename to docs/refactor/subscription-search-review.md diff --git a/docs/subscribe-lifecycle.md b/docs/subscribe-lifecycle.md index 90b508479..11936b12f 100644 --- a/docs/subscribe-lifecycle.md +++ b/docs/subscribe-lifecycle.md @@ -89,7 +89,7 @@ MoviePilot 当前以媒体类型和洗版方式组合出常用订阅模式。普 站点等待不代表搜索失败。其它站点仍在执行时保持搜索状态；本轮结束并保存续跑时间后才进入等待。 订阅搜索的同站唯一在途预算、站点访问间隔和错误冷却始终生效。机制审查及后续优化边界见 -[订阅搜索机制审查](architecture/subscription-search-review.md)。 +[订阅搜索机制审查](refactor/subscription-search-review.md)。 ### 事实写入 diff --git a/scripts/generate_agent_api_surface_audit.py b/scripts/generate_agent_api_surface_audit.py index dbd2536b1..1f3253655 100644 --- a/scripts/generate_agent_api_surface_audit.py +++ b/scripts/generate_agent_api_surface_audit.py @@ -18,8 +18,8 @@ if str(PROJECT_ROOT) not in sys.path: from app.agent.policy.api import API_OPERATION_ROUTES # noqa: E402 from app.api.apiv1 import api_router # noqa: E402 -JSON_OUTPUT = PROJECT_ROOT / "docs/architecture/agent-api-surface-audit.json" -MARKDOWN_OUTPUT = PROJECT_ROOT / "docs/architecture/agent-api-surface-audit.md" +JSON_OUTPUT = PROJECT_ROOT / "docs/refactor/agent-api-surface-audit.json" +MARKDOWN_OUTPUT = PROJECT_ROOT / "docs/refactor/agent-api-surface-audit.md" HTTP_METHODS = frozenset({"GET", "POST", "PUT", "PATCH", "DELETE"}) TRANSPORT_TAGS = frozenset( diff --git a/skills/moviepilot-api/SKILL.md b/skills/moviepilot-api/SKILL.md index 48e2f33a8..6fefa2146 100644 --- a/skills/moviepilot-api/SKILL.md +++ b/skills/moviepilot-api/SKILL.md @@ -150,7 +150,7 @@ must be one of the following before the Agent may use its capability: and English parameter contract is added. The maintained route-by-route inventory is -`docs/architecture/agent-api-surface-audit.md`. Its generated drift test fails +`docs/refactor/agent-api-surface-audit.md`. Its generated drift test fails when OpenAPI changes without an explicit ownership decision. The management recovery route `POST /api/v1/history/transfer/{history_id}/discard-corrupt` diff --git a/tests/test_agent_api_surface_audit.py b/tests/test_agent_api_surface_audit.py index 3845dec41..b40bb84f0 100644 --- a/tests/test_agent_api_surface_audit.py +++ b/tests/test_agent_api_surface_audit.py @@ -9,8 +9,8 @@ from app.agent.policy.api import API_OPERATION_ROUTES from app.agent.tools.impl.api import MoviePilotApiTool PROJECT_ROOT = Path(__file__).resolve().parents[1] -AUDIT_JSON = PROJECT_ROOT / "docs/architecture/agent-api-surface-audit.json" -AUDIT_MARKDOWN = PROJECT_ROOT / "docs/architecture/agent-api-surface-audit.md" +AUDIT_JSON = PROJECT_ROOT / "docs/refactor/agent-api-surface-audit.json" +AUDIT_MARKDOWN = PROJECT_ROOT / "docs/refactor/agent-api-surface-audit.md" API_SKILL = PROJECT_ROOT / "skills/moviepilot-api/SKILL.md" diff --git a/tests/test_architecture_contract_baseline.py b/tests/test_architecture_contract_baseline.py index bee66b277..6b443bbdb 100644 --- a/tests/test_architecture_contract_baseline.py +++ b/tests/test_architecture_contract_baseline.py @@ -107,13 +107,13 @@ def test_architecture_documents_match_generated_quality_metrics() -> None: checklist = ( PROJECT_ROOT / "docs" - / "architecture" + / "refactor" / "optimization-checklist.md" ).read_text(encoding="utf-8") roadmap = ( PROJECT_ROOT / "docs" - / "architecture" + / "refactor" / "refactor-roadmap.md" ).read_text(encoding="utf-8") edge_count = f"{dependency['edge_count']:,}"