Documented test result metadata in UI

[validbeck]

Internal Notes for Reviewers

For sc-4768, I:

• Created a net-new page discussing working with test results (& viewing their metadata): developer/model-documentation/work-with-test-results.qmd
• Retooled developer/model-documentation/generate-model-documentation.qmd to have a cleaned up workflow only (with much less confusing instructions!)
• Then, created a new landing page (developer/model-documentation/generating-model-documentation.qmd) for the conceptual workflow overview and shoved all the relevant articles under here

Work with test results

• This page expands on some of the content from "Work with content blocks" — which I cleaned up a little to link out to this guide for test-driven blocks instead of having a section of confusing conditional instructions.
• After laying the foundation I then expanded on how to view the test result metadata

Add test results	View test result metadata

Work with content blocks

Since there's now an extended guide on test-driven blocks, I simplified this general context blocks guide to make room for a later potential overview of the text editor.

Old	New

Generate model documentation

• The old version of this page was a bit clunky, and the instructions jumped back and forth and were a bit hard to follow. I broke down the workflow into the overview and the actual instructions, then cleaned up the instructions to be hopefully a bit more parsable.

Old	New

Generating model documentation

• This is the new conceptual overview page, cleaned up, serving as the landing for all the articles relevant to the documentation generation workflow.
• The initial version of this guide was named "Model documentation workflow" but I think the action gerund is a bit clearer.

Old	New

Other additions & cleanup

Install and initialize the developer framework > Install and initialize ValidMind

• I noticed that when wrapped in a breadcrumb the variable is bœrked... not great, and while playing around with just plain text I think just using the simple product name is snappier, and sort of hammers home the "cohesion" element of the framework / UI being two pieces of the same puzzle.

Old	New

Get started

• Fixed up the developer/get-started-developer-framework.qmd to have the new "Generating model documentation" at the bottom and made the listings look a bit more uniform

Old	New

Navigation drop-down

• Added the new "Generating model documentation" landing to the developer framework drop-down

Old	New

Prerequisties

• I cleaned up the prereq sections for all the guides under "Generating model docuemntation"

Please note I noticed the extra comma while I was capping for this section, so if you see it in any other screenshots it's been resolved!

Old	New

Jupyter notebooks > Jupyter Notebooks

• I thought I had already changed this, but the actual proper noun (according to JH website) is "Jupyter Notebooks" so I've just adjusted our verbiage to match that.

[validbeck]

Hi @even-steven! Just wanted to check in with you that these instructions are accurate:

Add test results	View test result metadata

[even-steven]

Hi @even-steven! Just wanted to check in with you that these instructions are accurate:

Add test results View test result metadata

Hey @validbeck, looks great! One thing that might be worth mentioning is that Validators in the model can add test-driven blocks within Validation Reports and Developers can add test-driven blocks within the Documentation.

Very nice 👏🏽

[validbeck]

Thanks @even-steven, that's definitely info I didn't have!

[github-actions]

PR Summary

This pull request introduces several enhancements to the model documentation and developer guide for the ValidMind platform. The key changes include:

1. New Documentation Section: Added a new section for 'Generating Model Documentation' in the developer guide, providing a detailed workflow for generating, refining, and submitting model documentation.
2. Updated Navigation: Updated the _quarto.yml file to include links to the new documentation sections and reorganized the structure for better navigation.
3. Content Updates: Made several content updates across multiple files to improve clarity and accuracy, including fixing typos and updating terminology (e.g., 'Jupyter notebook' to 'Jupyter Notebook').
4. Prerequisites and Permissions: Added detailed prerequisites and permissions information to various documentation files to ensure users have the necessary access and setup before proceeding with tasks.
5. Code Snippet Updates: Updated code snippets and instructions for initializing the ValidMind developer framework, ensuring they are accurate and up-to-date.
6. Footnotes and References: Added and updated footnotes and references to guide users to relevant sections and external resources.
7. Visual Aids: Included new images and GIFs to visually demonstrate steps in the documentation, enhancing user understanding.

These changes aim to improve the overall user experience by providing clearer, more comprehensive, and visually aided documentation for model developers using the ValidMind platform.

Test Suggestions

• Verify that the new 'Generating Model Documentation' section is accessible from the navigation menu and displays correctly.
• Check all links in the updated _quarto.yml file to ensure they point to the correct documentation sections.
• Test the updated code snippets for initializing the ValidMind developer framework to ensure they work as expected.
• Review the new images and GIFs to ensure they are correctly displayed and relevant to the content.
• Ensure that all added prerequisites and permissions information is accurate and helps users set up their environment correctly.
• Check for any broken links or references in the updated documentation files.

[nrichers]

This PR moves the needle on some protracted content structure issues we have in our developer doumentation. Very nice!

I am going to request some changes, mainly to debunk some of our topic titles further and to sort out the section numbering (happy to chat more if you think it would be useful).

[validbeck]

Changes:

[nrichers]

LGTM after your latest revisions. Thank you! 🚀