Rework docs to use polyglot notebooks
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- F#
- Star
- 860
- Fork
- 99
- Merge trung bình
- 22 phút
- Pull request đã merge (30 ngày)
- 1
Mô tả
Since fsdocs now supports generation of documentation with notebooks as input, a rework of the docs that also offers side-by-side examples for F# and C# is overdue.
I think this should be done gradually with a mechanism that allows publishing the new and old docs together as long as not all pages are ported.
This also would be a huge step forward for #376 , at least in a way that we could provide the docs in a format that is needed for the official pipeline.
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 việc xem xét hỗ trợ của fsdocs cho tài liệu dựa trên notebook và các yêu cầu trong issue #376. Xác định cách có thể phát hành đồng thời tài liệu mới và cũ trong quá trình di chuyển dần, sau đó xác định phạm vi cho các ví dụ F# và C# đặt cạnh nhau cũng như định dạng pipeline chính thức.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- csharp, fsharp
- Lĩnh vực
- documentation
- 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