freeCodeCamp/devdocs

Add docs for mc-stan.org

Open

#1752 opened on May 17, 2022

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Ruby (38,907 stars) (2,598 forks)batch import
docs/new+requesthelp wanted

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

Contributor guide

Tech stack
ruby
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
RubyDevdocs scraping framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
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.