Automatically update gh-pages after Documentation and examples have been committed
Đang mở
Chưa có ai nhận issue này.
documentation
enhancement
- Ngôn ngữ chính
- TypeScript
- Star
- 153
- Fork
- 46
- Merge trung bình
- 1 ngày 8 giờ
- Pull request đã merge (30 ngày)
- 7
Mô tả
Currently there seems to be a lack of automatic update of gh-pages when new documentation is added. We also need to generate the API documentation using npm run doc for gh-pages, since I think it's bad practice to commit files that are automatically generated anyway.
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.
Hướng nghiên cứu
Bắt đầu bằng cách xác định workflow phát hành gh-pages và các entry point build của tài liệu cũng như các ví dụ. Chạy npm run doc để hiểu tài liệu API được tạo, sau đó xác minh rằng các thay đổi đối với tài liệu kích hoạt các bản cập nhật gh-pages mà không commit các tệp được tạo.
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
- ci-cd, documentation
- Loại issue
- Tính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- 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
- 35/100