Documentation Improvement
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ài liệu
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- elixir
- Lĩnh vực
- documentation
Hướng nghiên cứu
No files or tests are named. Begin by reviewing the existing Hexdocs and Surface-UI.org documentation, then determine whether they serve different purposes; done requires a clarified documentation scope and a concrete plan for improving Hexdocs.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Surface is an amazing project.
I think it'll be helpful if increased attention is given to its documentation.
Specifically, why are there two alternative documentations? Hexdocs and Suface-UI.org? Are they to serve different purposes?
I suggest that investing effort into an improved hexdocs page will suffice.
- Ngôn ngữ chính
- Elixir
- Star
- 2.1k
- Fork
- 146
- 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
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
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 surface-ui/surface
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 78/100
surface-ui/surface#634 · 1 reaction ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
surface-ui/surface#770 ·
-
Website is downĐang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
surface-ui/surface#768 · 4 bình luận ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
surface-ui/surface#762 · 2 bình luận · 1 reaction ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
surface-ui/surface#759 · 1 reaction ·
Tất cả issue của surface-ui/surface
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
electric-sql/electric#4830 ·
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 75/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Gradle release-date fallback accepts `Last-Modified` from non-2xx responses, so `cooldown` lets brand-new plugin versions throughCó thể đã có người làm @v-robaiken đã nhận 1 ngày trước. Đang mởL: java:gradle T: bug 🐞
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
dependabot/dependabot-core#16547 · 1 reaction · 2 người được giao ·
Maintainer thường phản hồi trong vòng 1 ngày
-
github_actions
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 94/100
Maintainer thường phản hồi trong vòng 1 ngày