coder / coder/backstage-plugins
Autogenerate API docs
- 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
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
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
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.
Đánh giá
- Công nghệ
- typescript
- Lĩnh vực
- api, documentation
- Loại issue
- Tính năng
- Độ 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
- 25/100