QuantEcon/QuantEcon.jl

Redo documentation 2

Open

#365 建立於 2025年11月4日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Julia (495 star) (300 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.