Repo for Stan documentation - now online!

The docs repo now contains the Stan reference manual, functions reference, and user’s guide (a.k.a. “Bayesian Statistics Using Stan”)

We can move the CmdStan, RStan, and PyStan docs into this repo as well.
The landing page is
http://mc-stan.org/docs/

The HTML versions of the Stan manuals were introduced in 2.18. The index page has links to the pdfs for 2.17. Going forward, there will be new versions of the HTML and pdfs with each release.

Next steps here are:
1. add manuals for the interfaces

this definitely needs to be done for CmdStan because right now there’s not an online version of the manual. the Rmarkdown/pandoc/knitr toolchain is nice because we can generate both online and print versions of the docs.

2. create unversioned HTML docs which automatically redirect to the latest version for which the URL is valid, e.g.:

a request for “http://mc-stan.org/docs/functions-reference/step-functions.html” will automatically redirect to “http://mc-stan.org/docs/2_18/functions-reference/step-functions.html” for now, and next release will redirect to “http://mc-stan.org/docs/2_19/functions-reference/step-functions.html”.
if a page (i.e. chapter) is removed from the next version of the manual, the redirect page won’t be updated, so it will still work. don’t yet have the scripts to make this happen in place.

after some offline discussion with Bob, not sure if this is a real problem that needs to be solved

in the meantime, happy browsing,
Mitzi

3 Likes