Set up initial documentation
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 20/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- jupyter-notebook, python
調査の方向性
まず、issue にある3つの質問を解決します。リポジトリの目的、ドキュメントとチュートリアルをどのように分けるか、そして MkDocs と mdBook のどちらを使うかです。issue にはファイル名やテスト名の指定はありません。ドキュメントの範囲、チュートリアルの配置場所、GitHub Pages のツールが合意されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
At some point, we will probably want the code and notebooks in this repo to have documentation on GitHub Pages.
We will need to work out a few things before we do that, namely:
- What do we want this repo to be for? Are we going to publish a Python package or is it just example Jupyter notebooks etc.?
- How are we going to divide the documentation between this repo and the main one? Where should tutorials live?
- What tooling do we want to use for this? MkDocs is the obvious choice (there is also a plugin for notebooks), but we could also go with mdBook, as we've done for the main repo, for consistency.
My feeling about 2 is that it probably makes sense to have tutorials in this repository, as we will want to walk users through analysing the data, which will be easier if we embed Jupyter notebooks.
- 主要言語
- Python
- スター
- 0
- フォーク
- 0
- 平均マージ
- 17時間 5分
- マージ済み PR（30日）
- 11
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
EnergySystemsModellingLab/muse2_data_analysis のほかの issue
-
EnergySystemsModellingLab/muse2_data_analysis#59 · 担当者 1 名 ·
EnergySystemsModellingLab/muse2_data_analysis の issue をすべて見る
似ている issue
-
triage/confirmed
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
agentscope-ai/agentscope#2775 ·
-
comp/desktop P3 type/bug
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
NousResearch/hermes-agent#118866 ·
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
apache/cloudstack#14222 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100