QuantEcon/QuantEcon.jl

Redo documentation 2

Open

#365 geöffnet am 4. Nov. 2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (300 Forks)batch import
docshelp wanted

Repository-Metriken

Stars
 (495 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 1T 1h) (2 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Verstehe die vorhandene Dokumentationsstruktur und plane, wie sie in ein Benutzerhandbuch und einen API Referenzabschnitt aufgeteilt werden kann.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80