automated docs review

Đang mở
#431 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

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ả

enhancement help wanted

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

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của flashbots/contender

Tất cả issue của flashbots/contender

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.