TuringLang / TuringGLM.jl

Bayesian Generalized Linear models using `@formula` syntax.
https://turinglang.org/TuringGLM.jl/dev
MIT License
70 stars 7 forks source link

Documentation and Tutorials #23

Closed storopoli closed 2 years ago

storopoli commented 2 years ago

This is the last PR to the initial release. Closes #2.

There is a nice quick start in the index.md along with all the docstring in the api.md.

The tutorials covered are "quick and dirty", we can improve more later. They are:

I also added a favicon.ico and turing logo to the documenter pages.

rikhuijzer commented 2 years ago

The tutorials are very broken even though CI passes. There are two things we can do now:

  1. Ensure that the docs build fails first and then fix the docs.
  2. Switch to PlutoStaticHTML. I can set it up for you if you want. With PlutoStaticHTML, builds will fail if there is an error and we can provide readers with a notebook link which they can run locally.
storopoli commented 2 years ago

I all up for PlutoStaticHTML.jl. Can you convert the PR to use it?