Skip to content

chore(dsh-provider-usage): 过期文档以当前架构为准清理 + 源码注释去过程标记(#681) - #686

Merged
wingsky-1 merged 3 commits into
mainfrom
task/681-cleanup
Sep 10, 2026
Merged

wingsky-1 merged 3 commits into
mainfrom
task/681-cleanup

Conversation

@wingsky-1

Copy link
Copy Markdown
Owner

遗留清理:过期文档以当前架构为准 + 源码注释去过程标记(跟踪 #681)

变更内容(2 提交)

1. 过期文档清理(f8e5d00)

  • layer-architecture-next-session.md(交接 prompt)归档 → docs/archive/
  • refactor-implementation-plan.md 由「实施计划」改写为「架构现状与决策记录」:删除阶段零→收尾计划/评审过程/实施跟踪,保留并校正 D1-D17 决策表、当前目录树、35 文件映射表
  • layer-architecture.md 契约基线同步目录化后「文件 · 符号」路径(trend/→domain2/aggregate/ 等 24+ 处),去双专家评审/基线快照 e64f859 等过程痕迹,补 D-17;图索引只列现状图并注明契约以符号锚为准
  • test/ 中 4 处文档章节引用注释同步

2. 源码注释清理(b4aa983)

门禁证据(主控复跑确认)

  • typecheck / build / test 21 套 / docs:check(verify-docs --strict-en)/ contract(verify-dir-imports 符号存在性 PASS)/ stryker:check(27 份)全绿
  • 残留 grep:#[0-9]{3,4}|阶段[零一二三四五] 排除非编号命中后 0 残留
  • diff 复查:无任何代码/字符串行改动(仅注释)

Related: #681

…#681)

- layer-architecture-next-session.md(纯交接 prompt,重构已完成使命结束):
  归档至 docs/archive/ 而非删除——保留 git 历史可追溯,docs/ 不入发布物
  files 白名单(仅 lib/shared/**/*.d.ts/cordis.patch.yml/README/LICENSE),
  无其它文档/README 引用该路径,无需改引用
- refactor-implementation-plan.md 由「实施计划」改写为「当前架构与决策的静态说明」
  (文件名保留使 diagrams 图内引用与 test 注释路径不断链):删除阶段方案表
  (阶段零→收尾)、阶段 PR 序列、双专家评审/必改 8 项、实施跟踪等过程叙述;
  保留并校正决策表 D1-D17、目录树(补 errsurf/list-dirs/aggregate-rows/
  aggregate-query,去未实施的 prompts.ts 与 apply 拆分残余)、35 文件映射表、
  冲突裁决结论(interface.ts 最小面具名导出、死面清理完成态、import 边界门禁现状)
- layer-architecture.md 契约基线:契约表「文件 · 符号」引用路径全部同步目录化后
  (report/config.ts→domain2/schedule/config.ts、trend/aggregator.ts→
  domain2/aggregate/aggregator.ts、core/history.ts→domain1/history/history.ts、
  apply.ts→apply/apply.ts、routes/ui.ts→domain2/routes/ui.ts 等,按实际 grep 逐条校正);
  去评审过程叙述(双专家评审合并版/G2 评分/⚠️修订标注)、基线快照 e64f859 证据引用;
  决策表补 D-17;目录化已完成故图索引只列现状图并注明「图含目录化前路径,
  契约以符号锚为准」;源文件注释中的 §2/§2.3/§4 章节引用保持有效
- 同步 test/ 4 处注释中的文档引用至新章节(§2/§2 E2)

关联 issue:#681(C1 过期文档同步)、#670(重构跟踪)
清理口径与保留标准:
- 删除「阶段/子项」与 issue 编号来源标记(#503/#633/#654/#662/#625/#626/#670 等,
  以及 M1/M2/A1/B1/D8/E3 等子项代号、评审 P1-x/复核 M1 等过程编号)——编号只
  记录「哪个阶段哪个 issue 做的」,属提交信息而非代码注释的职责;
- 编号前缀之后的非显然技术内容(坑/竞态/边界/跨文件口径锚点)原样保留,仅去编号;
- 删除描述性「正确的废话」与纯流程性行注释;
- 文件头「模块职责 + 关键口径」总述保留,去过程尾巴(如 D2 拆分、阶段四目录化归位);
- 功能性指令注释(dsh-gate:allow-homedir)、字符串/模板文本(提示词模板、HTML 实体
  示例 {、microsoft/TypeScript#63960 外部引用)一律不动。

来源上下文:本提交为 #681(dsh-provider-usage 注释清理跟踪)的「注释清理」单元;
源码中的阶段标记(阶段二/三/四、#670 阶段三 B、D8 归位等)对应 #670「阶段四
两级目录化」工作——这些过程信息已随 #670 各提交的 commit message 记录,
无需在注释中重复。

门禁:typecheck / build / test(21 套)全绿。
)

注释清理误删了豁免注释中的 #NNN——forbid-homedir-src 的 EXEMPT_RE
要求豁免注释必须携带 issue 编号(dsh-gate:allow-homedir #NNN 理由),
该编号是豁免登记的必要格式而非过程标记。恢复 apply.ts(#517)、
path-resolve.ts(#87)、provider-config.ts(#525)。

Related: #681
@wingsky-1
wingsky-1 merged commit b428269 into main Sep 10, 2026
25 checks passed
@wingsky-1
wingsky-1 deleted the task/681-cleanup branch September 10, 2026 01:18
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