QuantEcon/QuantEcon.jl

Redo documentation 2

Open

#365 opened on 2025年11月4日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Julia (300 forks)batch import
docshelp wanted

Repository metrics

Stars
 (495 stars)
PR merge metrics
 (平均マージ 1d 1h) (30d で 2 merged PRs)

説明

Remaining task from #136:

  • Split the documentation into two parts:
    1. A user guide that goes over installation and usage. This section would include some examples and tutorials
    2. An API section where we just dump all the docstring info we will be re-writing.

コントリビューターガイド

調査方針
既存のドキュメント構造を理解し、それをユーザーガイドとAPIリファレンスセクションに分割する方法を計画してください。
技術スタック
なし
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80