freeCodeCamp/devdocs

Add docs for mc-stan.org

Ouverte

#1 752 ouverte le 17 mai 2022

Voir sur GitHubGuide contributeur
 (7 commentaires) (0 réaction) (0 personne assignée)Ruby (2 598 forks)batch import
docs/new+requesthelp wanted

Métriques du dépôt

Stars
 (38 907 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Examinez les scrapers existants de Devdocs pour des sources de documentation similaires (par exemple, scikit learn) afin de comprendre le format requis. Consultez le dépôt de documentation MC Stan (https://github.com/stan dev/docs) pour localiser les fichiers HTML de référence des fonctions. Implémentez un nouveau scraper basé sur le modèle utilisé par d'autres scrapers dans le projet Devdocs.
Stack technique
ruby
Domaine
documentation
Type d'issue
Fonctionnalité
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.
75