Add documentation for exposed types
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ệ
- typescript
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu bằng việc xem xét các kiểu và interface được export của TypeScript, sau đó so sánh các tùy chọn tạo tài liệu được đề cập trong issue: TypeDoc, typegen và api-extractor. Công việc được xem là hoàn tất khi tài liệu hướng đến người dùng cho các kiểu được exposed đã được tạo và phương pháp được chọn đã được tích hợp vào dự án.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Is your feature request related to a problem? Please describe.
There is absolutely no user-facing documentation for any of the exposed types/interfaces.
Describe the solution you'd like
Autogeneration of documentation from the exported types would be nice.
Describe alternatives you've considered
A simple web search turns up a few options, such as this or this. Additionally, api-extractor, which I've looked into using for other reasons, can do this as well.
- Ngôn ngữ chính
- TypeScript
- Star
- 437
- Fork
- 61
- Merge trung bình
- 16 giờ 2 phút
- Pull request đã merge (30 ngày)
- 8
Hướng dẫn đóng góp
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 StackExchange/Stacks-Editor
-
enhancement
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
StackExchange/Stacks-Editor#504 · 1 bình luận · 2 reaction ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 25/100
StackExchange/Stacks-Editor#395 · 1 bình luận ·
-
enhancement
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
StackExchange/Stacks-Editor#343 · 1 bình luận ·
-
Task list support Đang mởenhancement
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
StackExchange/Stacks-Editor#272 · 1 bình luận ·
-
Math formulas support Đang mởenhancement
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
StackExchange/Stacks-Editor#250 · 1 bình luận ·
Tất cả issue của StackExchange/Stacks-Editor
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 75/100
mksglu/context-mode#1200 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
jaegertracing/jaeger-ui#4506 ·
-
area:desktop area:ui bug platform:macos
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
anthropics/claude-code#96687 ·
-
good first issue
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 95/100
AOSSIE-Org/DebateAI#582 · 2 bình luận ·