julia-mpsge/MPSGE.jl

Rewrite Markusen examples using Literate.jl

Open

#200 opened on May 27, 2025

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Julia (3 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (22 stars)
PR merge metrics
 (PR metrics pending)

Description

Issue

Currently the Markusen examples (in the examples directory) use Jupyter notebooks. It will be better to have these as standard Julia files.

Solution

Write the Markusen examples so that

  1. They formatted to satisfy Literate.jl
  2. Include in documentation
  3. Run examples as tests (using doctest) to ensure they always work.

Contributor guide

Research direction
Study Literate.jl documentation and convert each Jupyter notebook to a .jl file with markdown cells as comments. Ensure examples are included in documentation via Literate.jl's `notebook` or `markdown` functions, and add doctests to run as tests.
Tech stack
julia
Domain
documentationtesting
Issue type
Refactor
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.
Half day
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
JuliaLiterate.jl
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60