Skip to content

内部文档(仓库可见 · 站点隐藏)

以下目录不发布到文档站(由 .vitepress/config.tssrcExclude 排除), 属开发过程产物 / 内部参考层——面向开发者与 AI 协作,而非终端用户。 需要阅读时请到 GitHub 仓库 docs/直接浏览(或本地仓库)。

目录清单

目录内容典型读者状态
audit/代码审核报告(按日期命名,覆盖 env / manager / outfit / 感知层等模块)开发者、AI 审查员持续产出
research/技术调研(Wails v3 源码分析、babylon-mmd API、竞品分析、格式研究)架构师、技术选型按需调研
ai-new/AI 能力新闻周记(2026-07 起)关注 AI 集成进展者周更
upstream/上游依赖兼容性(babylon-mmd 文档镜像、兼容性说明)依赖升级时的维护者按需
superpowers/规划草稿(plans)规划期讨论草稿态
knowledge/.archive/知识卡归档(被合并/取代的旧卡,保留供追溯)考古排查时归档
audit 关联规范项目根 AGENTS.md 的「审核代码可用性」章节定义了审核流程与输出格式开发者

为什么隐藏

  • audit / research / ai-new过程性文档,多数内容会沉淀为 ADR / 知识卡后才对外;直接发布会让站点信息噪音大于价值。
  • superpowers / upstream草稿与镜像,不适合作为稳定文档入口。
  • 站点保留结论层(ADR + 知识卡 + 用户指南),过程层留在仓库——两层分工避免"过程文档 + 结论文档"双写漂移。

如何把某篇内部文档提升为对外文档

  1. 沉淀结论 → 新建/更新 ADR(npm run new:adr)或知识卡(npm run new:knowledge-card)。
  2. srcExclude 中移除对应目录(或把文件移到对外目录),重跑 npm run gen:docsindex
  3. 运行 npm run check:docs 验证无漂移后提交。