automated docs review
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- rust
- Lĩnh vực
- ci-cd, documentation, testing
Hướng nghiên cứu
Không có tệp, bài kiểm thử hoặc điểm vào nào được nêu. Hãy bắt đầu bằng việc xem xét tài liệu và cấu hình CI của repository, sau đó xác định cách nhận diện và thực thi các ví dụ Rust. Công việc được xem là hoàn tất khi có một phương án đã được thống nhất để kiểm tra đáng tin cậy các ví dụ trong tài liệu, đồng thời mọi khuyến nghị PR tùy chọn đều được xác định rõ phạm vi.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- Rust
- Star
- 144
- Fork
- 58
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của flashbots/contender
-
engine_newPayload filesĐang mởenhancement
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 45/100
-
server: generate reportsĐang mởenhancement
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
-
server: export DB from sessionCó thể làm lại được @zeroXbrock đã nhận 203 ngày trước và không có pull request nào đang mở. Đang mởenhancement help wanted question
-
enhancement
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 62/100
-
bug
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 52/100
Tất cả issue của flashbots/contender
Issue tương tự
-
priority middle
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
KATO-Hiro/AtCoderClans#13029 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
RustCrypto/formats#2544 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug ui
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
userFRM/egui-charts#3363 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
ada documentation mobile report
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 86/100
physicsdolphin/nv-uefi-unlocker#254 · 2 reaction ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
kindraywind/rustnarok-client#1382 ·
Maintainer thường phản hồi trong vòng 1 ngày