Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 1.25 KB

File metadata and controls

33 lines (25 loc) · 1.25 KB

BatchFlow 文档索引

当前建议把文档分成三层阅读:

  1. 先看 README,确认推荐用法和生命周期。
  2. 再看 API 参考配置说明,确认公开契约。
  3. 接着根据需要进入监控、测试和架构文档。

面向使用者

面向维护者

当前文档约定

  • READMEdocs/api/reference.mddocs/guides/metrics-spec.md 是一线契约文档。
  • 示例代码以仓库内真实 API 为准,不再使用历史包路径或过期签名。
  • test/integration 文档主要描述测试和仪表盘,不再承担业务接入文档角色。