QuantEcon/QuantEcon.jl

Redo documentation 2

Open

#365 ouverte le 4 nov. 2025

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Julia (300 forks)batch import
docshelp wanted

Métriques du dépôt

Stars
 (495 stars)
Métriques de merge PR
 (Merge moyen 1j 1h) (2 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Comprenez la structure de la documentation existante et planifiez comment la diviser en un guide utilisateur et une section de référence API.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80