Move official docs page to this repo and update accordingly
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ả
Currently, there are 2 sets of docs for this library:
-
docs hosted on https://plotly.net, which i will call internal in this issue:
- built in this repo using
fsdocs - contains tutorials rendered from
.fsxfiles and api docs created by fsdocs via assembly inspection - are up-to-date with the currently version of the library
- almost exclusively F# content (meaning C# users need to put in a little effort translating the code samples)
- built in this repo using
-
docs hosted on https://plotly.com/fsharp and https://plotly.com/csharp , which i will call official in this issue
- built with the behemoth docs build pipeline of plotly, which i currently have absolutely no idea how it works, other than that they most likely use the content of https://github.com/plotly/plotly.net-docs. https://github.com/plotly/documentation/issues/1696 might help here eventually
- contains (incomplete) translations of the python tutorials hosted on https://plotly.com/python
- are severely out-of-date (using a preview version of 2.0.0)
- can host both F# and C# content
There is understandably quite some confusion about this (see #353 and #356), with users coming from the official docs reporting issues that are long fixed in recent versions. In addition to that, providing high-quality C# docs is hard with fsdocs, which mainly focuses on creating F# content with F# tooling.
Since official docs most likely have way better SEO than the internal one, this problem will only increase with time, meaning we should move to only hosting the official docs.
So the following should be done imo:
- change the doc build pipeline to use content in this repo instead of https://github.com/plotly/plotly.net-docs, since i do not want to maintain two separate repos for this. Python , JS, and R versions of plotly do it that way as well.
- use the api docs output from fsdocs, similarily to what the python lib is doing
- ditch fsdocs for the tutorials in favor of the official docs build 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 cách so sánh thiết lập fsdocs hiện tại trong repository này với nội dung và pipeline chính thức trong plotly.net-docs, đồng thời xem xét documentation/issues/1696 cùng các issues #353 và #356 để xác định các ràng buộc. Công việc được xem là hoàn tất khi pipeline chính thức sử dụng nội dung tutorial từ repository này, xuất bản tài liệu API do fsdocs tạo ra và không còn phụ thuộc vào một repository tutorial riêng biệt hoặc fsdocs tutorial build.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- fsharp
- Lĩnh vực
- build-system, 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
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100