Rework docs to use polyglot notebooks
オープン
まだ誰も着手していません。
Area: Documentation
- 主要言語
- F#
- スター
- 860
- フォーク
- 99
- 平均マージ
- 22分
- マージ済み PR(30日)
- 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.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、ノートブックベースのドキュメントに対する fsdocs のサポートと、issue #376 の要件を確認します。段階的な移行中に新旧のドキュメントを一緒に公開する方法を明らかにし、そのうえで F# と C# の例を横並びで示す範囲と、公式のパイプライン形式を定義します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- csharp, fsharp
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 25/100