Skip to content

docs: 精简 Concept 并对齐 Vein 文档规范 - #55

Merged
YTwsy merged 1 commit into
Metafrom
codex/docs-vein-concepts
Oct 9, 2026
Merged

YTwsy merged 1 commit into
Metafrom
codex/docs-vein-concepts

Conversation

@YTwsy

@YTwsy YTwsy commented Oct 9, 2026

Copy link
Copy Markdown
Owner

Concept 中仍混有实现入口表、具体操作和验证要求,容易与 source 重复维护。本次参考 Vein 的抽象规范及 OpenSurge-for-Mac #83,将 5 篇概念页重写为概念、关系、职责边界和带用途的来源导航,并加入 3 张简单关系图。

Concept 合计由 144 行降至 102 行,文件字符数由 11,224 降至 3,956。Wiki 索引直接连接全部 21 份当前 source;原有代码和文件入口保留在对应来源或索引。同步 AGENTS、Wiki 维护规则及文档检查要求,明确仅在概念含义、关系、边界或入口变化时更新 Concept。提交范围为 13 份 Markdown。

验证:

  • 针对提交 c059b27 的 Git 内容离线检查通过:32 份当前文档、676 处本地链接目标、119 处当前文档锚点、21 份 source 与 5 篇 Concept 的索引及直接来源入口。历史报告链接检查目标存在,不递归展开报告。
  • 核对 10 组原有约束的主要维护位置、44 个代码和文件入口的保留情况、旧锚点引用及默认历史检索过滤;git diff --check 通过。
  • 纯文档变更,本地未启动真实模型、测试客户端或产品构建;Go/Web 工程检查由本 PR 的 CI 执行。

参考:YTwsy/OpenSurge-for-Mac#83

@YTwsy
YTwsy merged commit 3cb3afa into Meta Oct 9, 2026
1 check passed
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