automated docs review
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- rust
- 领域
- ci-cd, documentation, testing
调研方向
未指定任何文件、测试或入口点。首先检查仓库的文档和 CI 配置,然后确定应如何识别和执行 Rust 示例。完成的标准是达成一种一致认可的方法,能够可靠地检查文档示例,并明确界定任何可选的 PR 建议的范围。
由索引模型根据 Issue 内容生成。
描述
Is your feature request related to a problem? Please describe.
It would be great if there was a CI job that could read the docs, run the examples, and make sure everything was still correct as we merge new PRs. As time passes and features get added/removed, docs (especially those that are example-oriented) can drift away from usefulness.
Describe the solution you'd like
There are a lot of possible solutions to this problem. We could use a simple parser to extract the rust examples and run them, but that could get convoluted quickly. We could also use AI. I don't know which is the best yet, but I'm just writing this quickly so a discussion can start.
The goal (first & foremost) ensure accuracy of code examples in docs.
If we can add AI code reviews and recommendations related to the PR (i.e. to remind the PR's dev to update the docs) that would be an excellent addition.
- 主要语言
- Rust
- 星标
- 144
- 派生
- 58
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
flashbots/contender 的其他 Issue
-
enhancement
难度 5/5 一周以上 新手友好度 45/100
-
enhancement
难度 4/5 3-5 天 新手友好度 45/100
-
server: export DB from session可能重新可做 @zeroXbrock 于 203 天前认领,目前没有进行中的 PR。 未关闭enhancement help wanted question
-
enhancement
难度 4/5 3-5 天 新手友好度 62/100
-
bug
难度 3/5 1-2 天 新手友好度 52/100
查看 flashbots/contender 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
open-telemetry/weaver#1917 ·
维护者通常 2 天内回复
-
bug host P3 web
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
documentation pkg:sdk project
难度 2/5 1-3 小时 新手友好度 76/100
-
priority middle
难度 1/5 1 小时以内 新手友好度 72/100
KATO-Hiro/AtCoderClans#13029 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
RustCrypto/formats#2544 ·
维护者通常 1 天内回复