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.
Redo documentation 2 · QuantEcon/QuantEcon.jl#365 | Good First Issue