API documentation needs a custom theme
- Ngôn ngữ chính
- Haskell
- Star
- 1.3k
- Fork
- 201
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
We should see try to theme haddock to make the API documentation less busy. Things like instances should be removed. The page structure should be re-organized to remove references to modules (like Prelude). Confusing notation should be removed for fixity declarations (or the entire fixity removed if it can't be phrased in a more friendly way.)
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu bằng cách xác định cách Haddock hiện tạo tài liệu API và xem xét cách xử lý các instance, các tham chiếu đến module như Prelude và các khai báo fixity. Công việc được xem là hoàn tất khi có một theme tùy chỉnh bớt rối mắt hơn với cấu trúc trang rõ ràng hơn, không còn các tham chiếu không cần thiết đến instance hoặc module, và ký hiệu fixity thân thiện hơn ở những nơi vẫn giữ lại nó.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- haskell
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ 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
- 20/100