Update documentation

[otzi5300]

(Moved from ADIH account to DHI branch)

Pull request addressing issue #69.

Create a User Guide Directory
Create Examples Section
Update Navigation
Update Home Page to similar structure like mikeio.
Add TSOD image

[adihellstrom]

I'm experiencing issues with uv sync, I think it's the "quarto-cli>=1.8.25" dependency.
Fix in same branch or open a new issue?

[adihellstrom]

Script for generating notebooks automatically is long but needed if we want the automated workflow. The latest commits skips converting notebooks -> qmd files, and directly converts to html.

Current flow is:

• .ipynb files from notebooks folder are copied/rewritten into examples folder as .ipynb.
• The script injects front matter into those notebook copies.
• It generates only one .qmd file for the listing page: index.qmd.
• HTML is produced later by Quarto during render (quarto render / uv run quarto render), not by the Python script itself.

Order of example notebooks is hardcoded for now. Which means that if we add new notebooks we need to update the ordering to include the new. Option: don't hardcode, and get order that is not convenient...

[ecomodeller]

@otzi5300 @adihellstrom Just making sure that you are aware of the quarto convert command https://quarto.org/docs/tools/vscode/notebook.html#converting-notebooks

[otzi5300]

I understand the general idea of automatically convert exmaple notebooks into docs/ . However, I think this is to complicated and needs simplification.

How about something in the line of:

Step 1: Configure _quarto.yaml in docs/
Step 2: Configure a yaml that marks what notebooks to convert and to what order.
Step 3 Run run "quarto convert" on the notebooks from 2 > qmd in examples
Step 4: run quarto render

Questions:
Is Makefile needed in docs?
Can we increase width of html? in convert or render? probably done in _quarto.yaml?

Goal:

• Except aligning with mikeio/modelskill
• Use already create notebooks in examples for docs. Convert as automatically and simple as possible, maybe with a config specifying order and selected notebooks for rendering.
• use Makefile and quarto as much as possible

[adihellstrom]

This PR should be closed without merge, is replaced by PR #86

[otzi5300]

Continued in v2 which is merged