freeCodeCamp/devdocs

Add docs for mc-stan.org

Open

#1752 aperta il 17 mag 2022

Vedi su GitHub
 (7 commenti) (0 reazioni) (0 assegnatari)Ruby (2598 fork)batch import
docs/new+requesthelp wanted

Metriche repository

Star
 (38.907 star)
Metriche merge PR
 (Merge medio 23g 15h) (7 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina gli scraper esistenti di Devdocs per fonti di documentazione simili (ad es. scikit learn) per comprendere il formato richiesto. Rivedi il repository della documentazione di MC Stan (https://github.com/stan dev/docs) per individuare i file HTML di riferimento delle funzioni. Implementa un nuovo scraper basato sul modello utilizzato da altri scraper nel progetto Devdocs.
Tech stack
ruby
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75