Come up with plan for API documentation tooling
Đang mở
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- C++
- Star
- 74
- Fork
- 9
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
We depend on documentation 4.0.0 as more recent releases removed polygot - refs documentationjs/documentation#850.
We either need to:
- Switch to a different tool
- Fix our usage of documentationjs to keep working with more recent versions
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.
Hướng nghiên cứu
Bắt đầu bằng việc xem xét sự phụ thuộc hiện tại vào documentation 4.0.0 và issue #850 của documentationjs được tham chiếu về tính năng polygot đã bị loại bỏ. So sánh hai hướng được đề xuất—chuyển sang công cụ khác hoặc sửa cách sử dụng để hỗ trợ các release mới hơn—và xác định việc hoàn thành là có một thiết lập tài liệu API được ghi lại và hoạt động.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- cpp, node.js
- Lĩnh vực
- api, documentation, tooling
- 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
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100