Rework how we include notebooks in our docs site

[nrichers]

Internal Notes for Reviewers

This is a companion PR to validmind/validmind-library#261.

Makefile changes

• make notebooks: Replace the old action of copying over individual notebooks & supporting files with copying over the entire notebooks folder, a much more reliable approach.
• notebooks.zip: Include README.md and LICENSE when we create a notebooks.zip for download via the docs site

Here's what make notebooks now copies over and zips up:

Notes:

• notebooks/tutorials: nothing here until we start building out our tutorial notebooks, as expected
• notebooks/code_sharing: removed from the docs site and .zip as notebooks might not run as-is or are internal
• README.md: included in the downloadable .zip to provide context. (Likely needs to be expanded a bit in #261 to make the download more standalone.) ADDED VIA fix: fixing issue with sklearn version validmind-library#266
• LICENSE: Add the license from developer-frameworks to the .zip file as we don't mention licensing anywhere else in our notebooks
• notebooks/code_samples/nlp_and_llm: For the docs site only, rename to notebooks/code_samples/LLM_and_NLP to help with new wildcard embed of notebooks (also see next section)
• index.qmd: Remove the old, separate action to copy over some supporting files into the generated site via Quarto, no longer needed. (Not part of Makefile but related to it.)
• Introduction_Customer_Churn.ipynb: Removed the extra copying in of this notebook from Google Drive, as it included the full suite that our main Quickstart now also includes. (Separate from this PR, we need to figure out what to do with the Google Drive files.)

"Code samples" page

• listing: Change page to be a listing page and embed notebooks in notebooks/code_samples/*/*. This wildcard embed removes the need to manually update a table with notebooks and reduces future maintenance. Adding new notebooks is now as simple as refreshing the notebook source.
• _quarto.yml: For the sidebar, also embed notebooks via wildcard. Quarto does this by subfolder, so we get some additional headings for free that group the notebooks.
• Text edits to put a bit more context around the Quickstart section, a leftover from the old table we had. Might not add much, but complements the new section of code samples.

Note: This also embeds the "Integrate an External Test Provider" notebook as it is a code sample that lives in notebooks/code_samples/custom_tests/external_test_providers_demo.ipynb. We now link to it from "Test and test suites" page, see the next section.

"Test and test suites" page

• listing: Same as "Code samples" page but embed /notebooks/how_to/*
• _quarto.yml: Same as for "Code samples" page
• Fix reference to "test plans" I had missed previously
• Add "Can I use my own test provider?" section with link to the code sample
• Reformat some existing text with a three-column layout to make it more compact

"Supported Models" page

• Minor: Fix the squished table and occasional right sidebar overlap by setting table width to .column-page.

"Developer Framework" drop-down

• Remove links to specific notebooks other than the Quickstart and replace with new link to "More samples"
• Add sample download link for notebooks.zip
• Font Awesome icon tweaks

External Release Notes

[mehdi0501]

On the "Test & Test suites" page.

• "Can I use my own test provider" => would suggest switching to "Can I use my own tests?"
• In the body: "Yes, ValidMind supports custom tests built by the user, or from 3rd party test libraries (aka "test providers"). We provide instructions for developing custom tests that can be integrated in the ValidMind library {point to the Custom tests page}. We also provide a code sample that demonstrates how to load and register test providers [...]"

Feel free to edit my suggestion, my point is just to: add a link to building custom tests in addition to connecting test providers, and to provide a definition of "test providers"

[nrichers]

• "Can I use my own test provider" => would suggest switching to "Can I use my own tests?"

  • In the body: "Yes, ValidMind supports custom tests built by the user, or from 3rd party test libraries (aka "test providers"). We provide instructions for developing custom tests that can be integrated in the ValidMind library {point to the Custom tests page}. We also provide a code sample that demonstrates how to load and register test providers [...]"

Thank you! I have reworked this section as suggested.