search

JuliaDiffusionBayes / DiffusionBayesTutorials

JupyterLab tutorials for working with DiffusionBayes.jl ecosystem
0 stars 0 forks source link

Outline for a parent documentation repository (to supersede this one) #1

Open mmider opened 4 years ago

mmider commented 4 years ago

I think we should avoid putting any scripts into any other packages of this suite (with the exception of DiffusionAnim.jl) and instead gather all of them here. This should help out with keeping our packages clear from clutter.

The scripts should be written as JupyterLabs so that someone browsing the repo doesn't need to have the package installed, nor even have Julia on their system, but should still be able to follow the analysis and see the results for himself or herself.

Some scripts should act as tutorials for how to use the package, but we need not limit ourselves to that and can include some cool analysis or tutorials that are not aimed at didactic introduction of various functionalities, but instead focus on the analyses, results, mathematics etc and use the package simply as a tool.

mmider commented 4 years ago

@fmeulen has started writing tutorials and I think he is right in having them rendered as .html files. I think, in the end, we want to have tutorials be tightly integrated with the remaining part of the documentation and raw JupyterLab files might end-up being too detached from it and be missed by the user.

mschauer commented 4 years ago

I think this package should be equipped with Documenter. the directory structure can be set up in a way that it works nicely. https://github.com/SciML/DiffEqDocs.jl has an example for a package which is only used to host docs. Tutorials are as Markdown files in https://github.com/SciML/DiffEqDocs.jl/tree/master/docs/src/tutorials

mschauer commented 4 years ago

This is a bit simpler: https://github.com/JuliaPhysics/juliaphysics.github.io

mmider commented 4 years ago

Sounds good to me. Following this path, we can probably substitute this repo for another one called DiffusionBayesDocs.jl, which would contain the general documentation for all subpackages, as well as tutorials, how-to-guides etc.

mschauer commented 4 years ago

That would make sense

mschauer commented 4 years ago

And I agree that having a script-folder in the packages self is not the cleanest option, especially if the packages become modular you wouldn't know how to put something