QuantEcon/QuantEcon.jl

Redo documentation 2

Open

#365 opened on 2025年11月4日

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

説明

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.

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

技術スタック
なし
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
familiarity with Markdownbasic understanding of QuantEcon.jl
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80
調査方針
The issue asks to split the existing documentation into a user guide (installation, usage, examples) and an API section (docstring info). Start by reviewing the current docs structure in the repository, likely under a `docs/` directory. Check issue #136 for the original context. The deliverable is a reorganization of documentation files, not writing new content from scratch. Focus on separating content logically and maintaining consistency.
Redo documentation 2 · QuantEcon/QuantEcon.jl#365 | Good First Issue