Add a getting started tutorial

[SamuelBrand1]

This is WIP aimed at addressing #100 (and contributing to #97) using a Pluto notebook approach to documentation examples.

The approach is to create the getting started tutorial as a notebook, which is easy to develop and also works as a .jl script. HTML render for documentation can be supplied by PlutoStaticHTML.

[SamuelBrand1]

Additions:

• The getting started example Pluto notebook is here.
• The build step very closely follows TuringGLM docs approach here.

Not implemented

This PR only addresses a single notebook. We will add some method to automate adding all the examples to the linked pages in the docs in a future PR.

[seabbs]

This is all looking great to me. I guess we need the build uncomment and the toy model example in tests removed and this is good to go?

[SamuelBrand1]

This is all looking great to me. I guess we need the build uncomment and the toy model example in tests removed and this is good to go?

Yep. Also, CI check. It builds the docs locally, but still waiting for CI.

EDIT: ofc, I'd forgotten I'd left build commented...

[seabbs]

The docs are broken on main (so I'm not sure how they build for you locally) due to #108

[SamuelBrand1]

The docs are broken on main (so I'm not sure how they build for you locally) due to #108

Hmmmm....

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.74%. Comparing base (93eb67c) to head (e805792).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #109   +/-   ##
=======================================
  Coverage   97.74%   97.74%           
=======================================
  Files           6        6           
  Lines         133      133           
=======================================
  Hits          130      130           
  Misses          3        3           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[seabbs]

This is looking really good. Two minor points

[seabbs]

Note I think that #115 should be addressed here as its linked to this PR and @SamuelBrand1 likely has all the context here from freshly porting over the example

[SamuelBrand1]

Note I think that #115 should be addressed here as its linked to this PR and @SamuelBrand1 likely has all the context here from freshly porting over the example

OK, and I hadn't updated the notebook to reflect the new latent_model kwarg. Annoying.

[SamuelBrand1]

I think the only dep we didn't want in Test env was CSV. The DataFramesMeta dep gets used in testing spread_draws

This PR closes #115

[seabbs]

Nice. LGTM