freeCodeCamp/devdocs

Add docs for mc-stan.org

Open

Aperta il 17 mag 2022

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

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

Tech stack
ruby
Dominio
documentation
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
RubyDevdocs scraping framework
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50
Direzione di ricerca
Examine existing Devdocs scrapers for similar documentation sources (e.g., scikit learn) to understand the required format. Review the MC Stan documentation repository (https://github.com/stan dev/docs) to locate the functions reference HTML files. Implement a new scraper based on the pattern used by other scrapers in the Devdocs project.