[mkdocs] Add github action to build the docs
Đang mở
Chưa có ai nhận issue này.
documentation
- Ngôn ngữ chính
- JavaScript
- Star
- 18.3k
- Fork
- 2k
- Merge trung bình
- 2 ngày 12 giờ
- Pull request đã merge (30 ngày)
- 28
Mô tả
Could be helpful to have a github action that runs the required steps to test generating the output.
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 cách xác định các lệnh hiện có trong repository để tạo và kiểm thử tài liệu bằng MkDocs, sau đó kiểm tra cấu hình workflow hiện tại để tìm điểm vào phù hợp. Công việc hoàn tất khi một workflow của GitHub Actions chạy các bước kiểm tra cần thiết để tạo tài liệu và xác minh rằng đầu ra có thể được tạo ra.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- github-actions
- Lĩnh vực
- build-system, ci-cd, documentation
- Loại issue
- Tính năng
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- 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
- 42/100