freeCodeCamp/devdocs

Add docs for mc-stan.org

Open

#1.752 aberto em 17 de mai. de 2022

Ver no GitHub
 (7 comments) (0 reactions) (0 assignees)Ruby (2.598 forks)batch import
docs/new+requesthelp wanted

Métricas do repositório

Stars
 (38.907 stars)
Métricas de merge de PR
 (Mesclagem média 23d 15h) (7 fundiu PRs em 30d)

Description

Feature request

I am adding this issue to let people know that I am starting work on importing documentation for mc-stan.org. I had previously proposed this documentation on the gitr channel and got positive feedback for the idea.

Summary

The mc-stan documentation is somewhat similar to the scikit-learn documentation, and it is split into several parts:

  1. User's guide
  2. Stan language reference
  3. Stan functions reference
  4. User guides for projects building on top of Stan
  5. Case studies
  6. Tutorials

I think points 1.-3. could be added to devdocs.io. I think point 3. is lowest hanging fruit, so I will start with that.

The documentation for 1-3 is located at https://github.com/stan-dev/docs

Guia do colaborador

Direção de pesquisa
Examine os scrapers existentes do Devdocs para fontes de documentação semelhantes (por exemplo, scikit learn) para entender o formato necessário. Revise o repositório de documentação do MC Stan (https://github.com/stan dev/docs) para localizar os arquivos HTML de referência de funções. Implemente um novo scraper com base no padrão usado por outros scrapers no projeto Devdocs.
Pilha de tecnologia
ruby
Domain
documentation
Tipo Issue
Funcionalidade
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.
75