Update documentation v2

[adihellstrom]

This PR replaces #85

Goal: keep as simple structure as possible. One Makefile, one gitignore if not too much regarding docs. Avoid scripts if not necessary, but we want some automation so a script is needed, and we use a config_file to manage new example notebooks, and to manage titles etc (quarto doesn't handle this in a good way...). The script enables batch convert from config, enforce title/description/order, fix paths, remove stale qmd files, and sync the sidebar automatically.

Overall changes:

Moved design.qmd and getting-started.qmd to user-guide. Added similar links to docs/index.qmd as in mikeio.

.gitignore:
Added a Docs section with all docs-related ignores (generated .qmd files, _site/, _freeze/, api/, .quarto/, .quarto_ipynb files, *_files/ image folders) Deleted docs/.gitignore.

_metadata.yml:
Changed execute: enabled: false → freeze: auto (restored plot execution + caching). Added fig-responsive: true, necessary to get correct plot widths

docs_config.json (new file):
Created as the single source of truth for examples: notebook name, title, description, order.

index.qmd:
Changed listing to type: table with fields: [title, description]

_quarto.yml:
Examples sidebar rewritten by the conversion script to match config order

pyproject.toml:
Added matplotlib to the docs dependency group (quarto executes notebooks)

style.css:
Added rule to make plot images responsive (max-width: 100%)

convert_docs_notebooks.py (new file):
Conversion script: reads config → converts notebooks to .qmd (using quarto convert) → patches frontmatter → fixes data paths → removes stale files → rewrites sidebar

Makefile:
Added convert-notebooks target and made docs depend on it

Also: small changes in notebook headers.

[otzi5300]

Nice! two comments:

• maybe a link to "getting started" example in the top right info box in home? Other 3 have links but not this.
• In getting started the text needs update:

we now support dataframes as well. In fit() must be series or frame with 1 column. in detect() can be series or multicolumn frames. in detect(): If you pass series > series returned, if you pass frame > frame returned

[otzi5300]

minor fix in getting stated text about the pd.series

[adihellstrom]

One thing that bothers me a bit but doesn't seem to have an easy fix: order in example list is not the same in the list in the middle vs the list in the left side bar... Otherwise, ready to merge!

[otzi5300]

One thing that bothers me a bit but doesn't seem to have an easy fix: order in example list is not the same in the list in the middle vs the list in the left side bar... Otherwise, ready to merge!

Yes, I noticed that as well but not a big thing. Good work!