Files
reader/docs/README.md
T

4.4 KiB

文档索引

当前目录结构

  • docs/README.md
    • 文档总索引
  • docs/current/
    • 当前状态、收束入口、阶段导航
  • docs/design/
    • 当前实现的设计文档
  • docs/openclaw/
    • OpenClaw 日报聚合与下游对象设计
  • docs/notes/
    • 较上层的方案笔记与非最终设计
  • docs/archive/
    • 历史归档,不作为最新事实来源

当前推荐阅读顺序

  1. docs/current/context-reset-brief.md
    • 当前真实进度与下一步入口
  2. docs/openclaw/openclaw-handoff.md
    • 给 OpenClaw 的接手说明、环境变量、MCP 调用方式与已知限制
  3. docs/openclaw/openclaw-candidate-input-field-spec.md
    • 提供给 OpenClaw 的单篇结构化输入字段说明
  4. docs/openclaw/openclaw-delivery-payload-spec.md
    • 提供给 OpenClaw 的批量投递 envelope 说明
  5. docs/design/summary-mcp-service-design.md
    • 当前 MCP 服务的职责、接口和边界
  6. docs/design/filter-rule-engine-design.md
    • 过滤层的输入输出、规则结构与当前实现
  7. docs/design/filter-rule-engine-usage.md
    • 规则怎么写、怎么跑、结果怎么解读的使用说明
  8. docs/design/daily-keyword-index-design.md
    • 日报级词元库与周期性词元清洗 skill 设计
  9. docs/design/markdown-sink-design.md
    • 第一版 Markdown sink 的输入输出、目录结构与落地方式
  10. docs/openclaw/openclaw-daily-digest-refactor.md
  • 为什么要从单篇入库改成 OpenClaw 日报聚合链路
  1. docs/openclaw/article-candidate-daily-digest-schema.md
  • ArticleCandidateRecord、OpenClawCandidateInput 与 DailyDigest 的正式设计
  1. docs/design/source-schema-design.md
  • source -> item -> document 的对象设计
  1. docs/notes/reading-pipeline-design-notes.md
  • 更上层的阅读流方案与阶段划分
  1. docs/design/summary-loop-explained.md
  • 当前 LLM 摘要校验闭环的解释

当前文档分层

1. 当前状态与导航

  • README.md
    • 仓库入口与脚本运行方式
  • TODO.md
    • 当前优先级、已完成项、下一阶段任务
  • docs/current/context-reset-brief.md
    • 当前阶段状态的最短摘要
  • docs/README.md
    • 文档索引与阅读顺序

2. 当前实现设计

  • docs/design/summary-mcp-service-design.md
    • 当前内容提取 MCP 的真实设计
  • docs/design/summary-core-interface-design.md
    • 摘要/提取内核的接口抽象
  • docs/design/source-schema-design.md
    • source、item、document 三层 schema
  • docs/design/summary-loop-explained.md
    • 提取 JSON -> LLM 摘要 JSON -> 校验 的闭环说明
  • docs/design/filter-rule-engine-design.md
    • 第一版规则过滤引擎设计与落地位置
  • docs/design/filter-rule-engine-usage.md
    • 规则配置、调用方式与结果解读
  • docs/design/daily-keyword-index-design.md
    • 日报级词元库与周期性词元清洗 skill 设计
  • scripts/apply_term_suggestions.py
    • 人工确认后将建议写回 watchlist / change log 的脚本入口(见 README.md 用法)
  • docs/design/markdown-sink-design.md
    • 第一版 Markdown sink 设计与落地位置

3. OpenClaw 与下游设计

  • docs/openclaw/openclaw-handoff.md
    • OpenClaw 接手所需的运行说明、工具入口与已知限制
  • docs/openclaw/openclaw-candidate-input-field-spec.md
    • 提供给 OpenClaw 的单篇结构化输入字段说明
  • docs/openclaw/openclaw-delivery-payload-spec.md
    • 提供给 OpenClaw 的批量投递 envelope 说明
  • docs/openclaw/openclaw-daily-digest-refactor.md
    • 改造为 OpenClaw 日报聚合链路的原因与目标结构
  • docs/openclaw/article-candidate-daily-digest-schema.md
    • ArticleCandidateRecord、OpenClawCandidateInput 与 DailyDigest 的字段设计与对象关系

4. 方案笔记

  • docs/notes/reading-pipeline-design-notes.md
    • 整体阅读流、规则、sink、push 的方案笔记

5. 历史归档

  • docs/archive/content-extract-mcp-mvp-archive.md
    • MVP 阶段归档,部分状态已被后续进展覆盖

当前文档维护原则

  • docs/current/context-reset-brief.md 记录当前最新状态
  • TODO.md 记录任务优先级与下一步
  • outputs/README.md 记录当前输出目录约定
  • docs/archive/content-extract-mcp-mvp-archive.md 只当历史快照,不再作为最新事实来源
  • 新增阶段性进展,优先更新 README.md、TODO.md、docs/current/context-reset-brief.md