QuantEcon/QuantEcon.jl

Redo documentation 2

Open

#365 opened on Nov 4, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (495 stars) (300 forks)batch import
docshelp wanted

Description

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.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with Markdownbasic understanding of QuantEcon.jl
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.