Example config files omit the `presence:` block the parser accepts

未关闭 适合新手
#60 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
69/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
冷清
技术栈
rust
领域
documentation

调研方向

阅读 crates/podd-core/src/config/mod.rs 以查看 PresenceConfig 的字段,并阅读 ARCHITECTURE.md 了解 API 背景。然后检查 config.example.ron、config.pod3.example.ron 和 config.pod4.example.ron,了解选项的文档编写方式。完成标准是:示例在一个注释块中说明全部三个 presence 字段,或者明确指出 presence 仅在运行时可用。

由索引模型根据 Issue 内容生成。

描述

documentation good first issue

crates/podd-core/src/config/mod.rs defines Config.presence: Option<PresenceConfig> (fields baselines: [u16;6], threshold: u16, debounce_count: u8), and ARCHITECTURE.md documents a GET/POST /metrics/presence API around it, but none of config.example.ron, config.pod3.example.ron, or config.pod4.example.ron mention presence at all. A user has no documented way to discover or shape this option. Add a commented-out presence: (...) block (with the three fields and their meaning) to the example configs, or explicitly note it's runtime-only.


Filed from a repo-wide code audit (working tree at bcad746).

主要语言
Rust
星标
0
派生
0
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

GoogleBot42/podd 的其他 Issue

查看 GoogleBot42/podd 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。