QuantEcon/QuantEcon.jl

Redo documentation 2

Open

#365 opened on Nov 4, 2025

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

Repository metrics

Stars
 (495 stars)
PR merge metrics
 (Avg merge 1d 1h) (2 merged PRs in 30d)

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

Research direction
Understand the existing documentation structure and plan how to split it into a user guide and an API reference section.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80