Rust-GPU / Rust-GPU/rust-gpu.github.io

Consider moving the website into main rust-gpu repo

Đang mở
#14 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.

Ngôn ngữ chính
MDX
Star
16
Fork
8
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

I just threw it in here as that was the quickest way to get the webpage up with github pages.

Docs/website in the main repo:

Pros:

  • Docs stay close to the code, so it’s easier to keep them updated alongside changes.
  • Contributors only need to work in one place, so adding or updating docs is straightforward.
  • No need to manage multiple repos—everything lives together.
    Cons:
  • The repo gets bigger, which can slow down cloning and pull requests for everyone.
  • Mixing code and doc issues in one place can get messy, making it harder to focus on core development.

Using a separate repo for docs/website:

Pros:

  • Keeps the main repo cleaner and code-focused, so it’s easier to navigate.
  • Doc updates are simpler to track and review on their own, without touching the code.
  • Main repo stays leaner and faster to work with.
    Cons:
  • It’s tougher to keep docs in sync with code changes, as they’re in different places.
  • Managing a separate repo adds overhead, like additional issue tracking and reviews.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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.

Hướng nghiên cứu

Issue này là một đề xuất về việc tổ chức repository thay vì một nhiệm vụ triển khai đã được xác định. Hãy xem xét repository website hiện tại và repository rust-gpu chính, sau đó quyết định website và tài liệu nên được đặt ở đâu. Được xem là hoàn tất khi đã đưa ra và ghi lại một quyết định rõ ràng, bao gồm cả phạm vi di chuyển nếu có.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Lĩnh vực
documentation
Loại issue
Tái cấu trúc
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

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.