Docs - scenarios for using the Julia functions with outside inputs

[tdivoll]

Maybe via the repo documentation page, create some scenarios so users know how to work with the Jupyter notebooks if they already have some images or data from elsewhere.

[danielmwatkins]

I'm working on putting together a tutorial for some use cases. I'd like to learn more about how the documentation software works so I know how to add pages. Ideally, I can write a page describing the idea of the algorithm with a schematic of how the different modules work together. In addition, I'd like to add a quick-start section for the top-level functions, a tutorials section, and a references section. This is mainly stuff we can do if we can get pointers on how the documentation gets built.

[cpaniaguam]

@danielmwatkins The relevant files are under /docs. You'll see another Project.toml file there as building the doc html files requires the Documenter.jl package which is not an IceFloeTracker.jl dependency.

[danielmwatkins]

That's where I was looking, good to know that's the right spot! Good to know what that extra Project.toml file is doing. I'll read through the Documenter.jl documentation to see what format I should use for adding pages and images to the documentation.

On Wed, Nov 15, 2023 at 7:10 AM Carlos Paniagua @.***> wrote:

@danielmwatkins https://github.com/danielmwatkins The relevant files are under /docs. You'll see another Project.toml file there as building the doc html files requires the Documenter.jl https://documenter.juliadocs.org/stable/man/guide/ package which is not an IceFloeTracker.jl dependency.

— Reply to this email directly, view it on GitHub https://github.com/WilhelmusLab/IceFloeTracker.jl/issues/340#issuecomment-1812428693, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB6TAUIZCIQCJZOFOSX3NKDYESWNFAVCNFSM6AAAAAA4PMSGZ6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMJSGQZDQNRZGM . You are receiving this because you were mentioned.Message ID: @.***>