loopbackio / loopbackio/loopback-next

docs: move API references to tsdoc

Đang mở
#5,778 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.

Docs epic feature
Ngôn ngữ chính
TypeScript
Star
5.1k
Fork
1.1k
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
27

Mô tả

As part of our adoption of the four-quadrant documentation system (see #5549 and #5718), we should move API reference material from markdown files in site/docs folder to tsdoc comments in the source code.

This story is a part of #5113 Documentation improvements 2020Q3.

Acceptance criteria

List of places to modify:

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

Mở 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.

Hướng nghiên cứu

Bắt đầu bằng việc xem xét các trang được liệt kê trong site/docs và ngữ cảnh liên quan từ #5549 và #5718. So sánh các phần giống tài liệu tham chiếu với tài liệu API hiện có, đặc biệt là đối với Model, Interceptors, Life cycle, Context và Decorators. Công việc được xem là hoàn tất khi tài liệu tham chiếu được liệt kê đã được thể hiện trong tsdoc, các snippet trùng lặp đã được xử lý và trang Decorators liên kết đến tài liệu API liên quan.

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

Đánh giá

Công nghệ
typescript
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
Khá rõ ràng
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.