notebooks: Pulling in new Quickstart for model documentation

[validbeck]

Internal Notes for Reviewers

sc-7911

Note

To test:

1. Grab this PR: gh pr checkout 720
2. Call cd site in your terminal to navigate into the site directory where our docs site files live.
3. Call quarto preview to pull up a live version of the changed site.
4. Head to ValidMind Library then Quickstart for model documentation to view the .html version of the new notebook.

New Quickstart for model documentation path

Since the path/filename for the model documentation quickstart changed, this PR:

• Pulls in the latest notebook files from validmind-library branch: /beck/sc-7911/edit-code-samples-notebooks-quickstart-for
• Fixes the links broken by this change

Updated Makefile

SInce there is now a quickstart directory (as more will live in there), we've removed the Make command within the notebooks command to copy out the old file into the root folder.

External Release Notes

Taken care of in validmind/validmind-library#372.

[github-actions]

PR Summary

This pull request updates the project by modifying the paths and references to the Quickstart notebook for model documentation. The changes include:

• Removal of the step in the Makefile that moved the quickstart_customer_churn_full_suite.ipynb notebook to the root of the notebooks directory.
• Updates to various configuration and documentation files to replace references to quickstart_customer_churn_full_suite.ipynb with quickstart/quickstart_model_documentation.ipynb.
• Addition of a new notebook quickstart_model_documentation.ipynb in the quickstart directory, which serves as the updated Quickstart guide.
• Deprecation notice added to the old quickstart_customer_churn_full_suite.ipynb notebook, indicating it is outdated and directing users to the new Quickstart notebook.
• Updates to markdown files and documentation to reflect the new path and title for the Quickstart notebook.
• Minor content updates in some notebooks to improve clarity and consistency, such as adding links and updating descriptions.

Test Suggestions

• Verify that the new Quickstart notebook quickstart/quickstart_model_documentation.ipynb is accessible and functions as expected.
• Check that all links and references to the Quickstart notebook in documentation and configuration files point to the new location.
• Ensure that the deprecation notice in quickstart_customer_churn_full_suite.ipynb correctly directs users to the new Quickstart notebook.
• Test the build process to confirm that the removal of the Makefile step does not affect other operations.
• Review the updated content in the notebooks for accuracy and clarity.

[LoiAnsah]

I ran the command went through the updated page.
I can see that the Quickstart Notebook option under Validmind library have been changed to Documentation quickstart.

I skimmed through the text and noticed that under the section "Preprocessing the raw dataset", the content I had already reworded for PR 372 appears there. Do I need to include those changes here as well, or can we assume they’ll be merged through that PR?

[github-actions]

PR Summary

This pull request updates the project by modifying the paths and references to the Quickstart notebook for model documentation. The changes involve moving the quickstart_customer_churn_full_suite.ipynb notebook to a new location under notebooks/quickstart/quickstart_model_documentation.ipynb. Additionally, the PR updates various documentation files and configuration files to reflect this change in the notebook's path. The changes ensure that all references to the Quickstart notebook are consistent across the project, including links in documentation, sidebars, and other markdown files. Furthermore, the PR includes minor updates to the content of some notebooks, such as adding hyperlinks and clarifying instructions.

Test Suggestions

• Verify that the Quickstart notebook opens correctly from its new location.
• Check all updated links in the documentation to ensure they point to the correct notebook path.
• Ensure that the notebook content is rendered correctly in JupyterHub.
• Test the functionality of the notebook to confirm that it runs without errors.
• Review the sidebar and navigation links to ensure they reflect the updated notebook path.

[github-actions]

A PR preview is available: Preview URL

[LoiAnsah]

I checked the PR preview and the changes made to "Quickstart for model documentation" were present.