plotly / plotly/Plotly.NET

Rework docs to use polyglot notebooks

未關閉
#442 5 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

Area: Documentation
主要語言
F#
星號
860
分支
99
平均合併
22 分鐘
30 天內合併 PR
1

描述

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.

貢獻指南

這個儲存庫沒有索引到貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

先檢視 fsdocs 對以 notebook 為基礎之文件的支援,以及 issue #376 中的需求。釐清如何在逐步遷移期間同時發布新舊文件,接著定義並列呈現 F# 和 C# 範例的範圍,以及官方 pipeline 格式。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
csharp, fsharp
領域
documentation
Issue 類型
文件
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
需要釐清
新手友好度
25/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。