types of tutorials

[nielsenmb]

I was thinking of the ways we can present the various examples of what PBjam can do and how to interact with it.

To start with it's probably enough to have
example-session
example-star
example-advanced

But would it maybe be an idea in the future to restructure it so that in the docs we have

• Quick Start (basically example-session)
• Advanced (basically example-advanced)
• More Examples
  • How to use star class (basically example-star)
  • How to use a csv file
  • How to use custom timeseries
  • How to use custom power spectra
  • How to peakbag with GP widths

These would be short notebooks, stored safely in the docs directory where nobody will accidentally run them and/or clear all the outputs. And then we can have Guys Examples playground folder in the root directory that's just a free for all.

This should make it easier in future, when we start adding new features. Then we just write a short tutorial on how to use those new features.

[grd349]

Yes - this is a great idea! I want a playground! :)

[grd349]

We do need to look at this. I can make one with a custom time series. I'll add it to my todo list.