Autogenerate API docs
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ính năng
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- typescript
- Lĩnh vực
- api, documentation
Hướng nghiên cứu
Bắt đầu bằng việc xem xét cách tài liệu API hiện tại được tạo thủ công và so sánh quy trình đó với make gen trong coder/coder. Xác định những nguồn API và đầu ra được tạo nào sẽ liên quan; công việc hoàn tất khi tài liệu có thể được tạo lại một cách đáng tin cậy và luôn đồng bộ với các thay đổi của API.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Our format for API docs is great, but as they are manually created I can see how they can get out of sync quickly when we are making changes. We shouldn't do this before launch, but I wonder how we can autogenerate API docs, kind of like how we do wirth make gen on coder/coder
- Ngôn ngữ chính
- TypeScript
- Star
- 67
- Fork
- 9
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
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 coder/backstage-plugins
-
enhancement good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
coder/backstage-plugins#105 · 1 reaction ·
-
Update backstage dependencies Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
coder/backstage-plugins#148 ·
-
Coder plugin: Fallback authentication button still appears after user has already authenticated Đang mởbug
coder/backstage-plugins#146 · 1 người được giao ·
-
enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 45/100
coder/backstage-plugins#145 ·
-
bug help wanted
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
coder/backstage-plugins#144 · 1 bình luận ·
Tất cả issue của coder/backstage-plugins
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
vercel-labs/just-bash#464 ·
-
looksLikeSlug() is ASCII-only, so non-Latin entity slugs (e.g. Korean) skip exact match and collapse Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
TanStack/tanstack.com#1293 ·