Marcelo de Oliveira Rosa Prates 3ef70792e2 Replace tutorial notebook with marimo + static docs (#144) ...

* Replace tutorial notebook with marimo + static docs

Jupyter notebooks (.ipynb) are hostile to code review: every cell output
is a base64-embedded blob that churns on every run, and a 27 MB
examples.ipynb is essentially unreviewable. Moving the canonical
tutorial to a git-friendly marimo notebook and a static Markdown
walkthrough keeps code review diffs small, makes the source diffable
in pull requests, and lets the rendered tutorial live alongside the
library on the GitHub Pages site.

- Replace notebooks/examples.ipynb with notebooks/tutorial.py
  (marimo notebook, 35 cells, 15.1 KB).
- Add docs/tutorial.md with the same walkthrough rendered as Markdown
  plus 10 inline PNGs at docs/img/tour-01..tour-10-*.png extracted
  from the original notebook's cell outputs.
- Add Tutorial entry to mkdocs.yml nav; link from docs/index.md and
  README.md. README's inline tutorial block is replaced with a pointer
  table to docs/tutorial.md (README: 1062 -> 112 lines).
- Add marimo>=0.23.0 to requirements.txt; update .gitignore to keep
  the new tutorial.py whitelisted and to ignore marimo caches
  (__marimo__/, *.marimo).
- Fix mkdocs.yml site_url placeholder
  (yourusername.github.io -> marceloprates.github.io) so the GitHub
  Pages site's canonical links and sitemap point at the real domain.
- The 23 unrelated demo notebooks that lived alongside the tutorial
  are kept untracked in notebooks/untracked/ (gitignored as before).

* Restore README tutorial pointer and update Colab link

Follow-up to the tutorial-marimo conversion. The previous rebase onto
the upstream CI commit (ba59f1f) accidentally dropped the new README.md
rewrite because 'git checkout --ours' during a rebase selects the
upstream side, not the commit being applied. This restores the
112-line README.md with the tutorial pointer and updates the Colab
link from notebooks/examples.ipynb to notebooks/tutorial.py.

* Remove obsolete generate-readme CI workflow

The generate-readme.yml workflow and the notebooks_to_readme.sh script
it depended on were designed to run notebooks/examples.ipynb and
regenerate README.md from its cell outputs. Since examples.ipynb is
gone (replaced by the marimo notebook and static docs/tutorial.md),
this pipeline has no purpose and was failing the PR check.

Also removes the 13 orphan temp_readme_*.png files that the CI had
committed to pictures/README/ in ba59f1f — their source notebook
no longer exists.

2026-07-30 12:24:36 -03:00

2.2 MiB

2780x2762px

Raw Permalink History