[generics-rep] Add expanded documentation

Đang mở
#240 0 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

Read the library guidelines documentation section and the two referenced commits from documentation PR 338 to identify the proposed guides for generics-rep. Then check how core libraries structure expanded documentation and whether the referenced content is still suitable; done means adding the agreed guides in that structure. The issue has no comments or linked pull requests, so check whether the proposal is still current before starting.

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

Mô tả

type: documentation

The purescript-contrib library guidelines suggest an expanded documentation directory. If we follow that same structure for the core libs (like generics-rep), then I'd like to add these guides on how to derive from generic:
https://github.com/purescript/documentation/pull/338/commits/9409b9a047aaa176199053928177c92739566a72
https://github.com/purescript/documentation/pull/338/commits/bb30b1514c406ee24eb6796d86ba282de323c4b7

That content was originally proposed for the language reference in https://github.com/purescript/documentation/pull/338

Ngôn ngữ chính
PureScript
Star
168
Fork
90
Merge trung bình
3 ngày 1 giờ
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

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 purescript/purescript-prelude

Tất cả issue của purescript/purescript-prelude

Issue tương tự

Thêm issue về Documentation

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.