QuantEcon/QuantEcon.jl

Redo documentation 2

Open

#365 aberto em 4 de nov. de 2025

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (300 forks)batch import
docshelp wanted

Métricas do repositório

Stars
 (495 stars)
Métricas de merge de PR
 (Mesclagem média 1d 1h) (2 fundiu PRs em 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.

Guia do colaborador

Direção de pesquisa
Entenda a estrutura da documentação existente e planeje como dividi la em um guia do usuário e uma seção de referência da API.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80