From ab24555c971cce4db24111b1d0170c5a4fb07048 Mon Sep 17 00:00:00 2001 From: Jukka Aho Date: Sat, 9 May 2026 16:30:27 +0300 Subject: [PATCH] feat(docs): add README.md docs/tutorials/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) --- docs/tutorials/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/tutorials/README.md diff --git a/docs/tutorials/README.md b/docs/tutorials/README.md new file mode 100644 index 0000000..a99b80a --- /dev/null +++ b/docs/tutorials/README.md @@ -0,0 +1,17 @@ +# Historical Jupyter tutorials (not the 0.x API) + +The notebooks in this directory date from **2015–2016**. They target APIs that +predate the current type-stable pipeline (`Element{K,P,S,N}`, `DOFHandler`, +`AbstractKernel`, modern assemblers). + +They are **not** executed by package CI and are **not** built into the Documenter +site. Treat them as archaeology: + +- Prefer **`docs/src/index.md`**, **`AGENTS.md`**, and **`test/`** for runnable + examples. +- For the old `Problem` / Dict-field stack, read **`docs/src/legacy.md`** and + enable **`JULIAFEM_ENABLE_LEGACY=1`** only if you must reproduce historical + workflows. + +RST index files (`index.rst`, `notebooks.rst`) are legacy Sphinx-era metadata and +may be stale.