@gtagle & @panchicore Nik suggested that for feature work I start tagging in the feature owner to confirm if the documentation is accurate if he can't get to it fast enough! Let me know if you two can help/have any questions. :)

One item to discuss: I’m a bit confused by what should go under “Working with the model inventory” and “Managing the model inventory” in these PR changes. There’s overlap between topics in these sections — I’d maybe get rid of one of these?

To me, the existing working with the model inventory section is more of a "Get started" sort of idea, and the "Managing" is more advanced set up. 🤔 I personally like the separation of these two ideas, but I'm in agreement that maybe the seconds can be renamed? I know that the "Working with..." topic is linked A LOT elsewhere, including the developer-framework notebooks, so it might be a PITA to rename though.

PR Summary

This pull request introduces several enhancements and bug fixes to the model inventory documentation within the ValidMind platform. The key changes include:

1. New Guide for Configuring Model Interdependencies: A new guide (configure-model-interdependencies.qmd) has been added to help users link models within the inventory, view existing interdependencies, and manage upstream and downstream dependencies.

2. Reorganization of Model Inventory Documentation: The model inventory documentation has been reorganized for better clarity and navigation. This includes:

   • Consolidation of related guides under a new file (managing-model-inventory.qmd).
   • Updates to the _quarto.yml and guides.qmd files to reflect the new structure.

3. Content Enhancements: Several existing guides have been updated to improve clarity and provide additional context. Notable updates include:

   • customize-model-inventory-layout.qmd: Added a date field.
   • edit-model-inventory-fields.qmd: Removed outdated comments and troubleshooting section.
   • manage-inventory-custom-fields.qmd: Expanded description to include different custom field types.

4. Visual Aids: New images (model-interdependencies.png, upstream-model.png, downstream-model.png) have been added to the documentation to provide visual aids for understanding model interdependencies.

5. Release Notes Update: The release notes for August 13, 2024, have been updated to include a link to the new guide on configuring model interdependencies.

Test Suggestions

• Verify that the new guide for configuring model interdependencies is accessible and renders correctly.
• Check that the reorganization of the model inventory documentation does not break any existing links or navigation.
• Ensure that the updated guides (customize-model-inventory-layout.qmd, edit-model-inventory-fields.qmd, manage-inventory-custom-fields.qmd) display the new content correctly.
• Test the visual aids to confirm that images are loading and displaying as expected.
• Review the release notes to ensure the new link to the guide on configuring model interdependencies works correctly.

How's this? 🤔

PR Summary

This pull request introduces several enhancements to the model inventory documentation within the project. The key changes include:

1. New Guide on Configuring Model Interdependencies: A new guide (configure-model-interdependencies.qmd) has been added to help users link models within the inventory, view existing interdependencies, and manage them.

2. Reorganization of Model Inventory Guides: The structure of the model inventory guides has been reorganized for better clarity and navigation. This includes:

   • Adding a new file managing-model-inventory.qmd that serves as an overview for advanced features.
   • Updating references and links in _quarto.yml and guides.qmd to reflect the new structure.

3. Content Enhancements: Several guides have been updated to improve clarity and provide more detailed instructions:

   • customize-model-inventory-layout.qmd now includes a date: last-modified field.
   • edit-model-inventory-fields.qmd has been cleaned up by removing outdated comments and sections.
   • manage-inventory-custom-fields.qmd has been enhanced to describe the different types of custom fields available.
   • working-with-model-inventory.qmd has been updated to provide a clearer introduction to the model inventory.

4. Visual Enhancements: New images (downstream-model.png, upstream-model.png, model-interdependencies.png) have been added to support the new and updated guides.

5. Release Notes Update: The release notes for August 13, 2024, have been updated to include a new section on managing model interdependencies, with a link to the new guide.

Test Suggestions

• Verify that the new guide on configuring model interdependencies is accessible and renders correctly.
• Check that all links in the reorganized model inventory guides are working and point to the correct documents.
• Ensure that the new images are displayed correctly in their respective guides.
• Test the form button in the release notes to ensure it redirects to the correct guide.
• Review the updated content in customize-model-inventory-layout.qmd, edit-model-inventory-fields.qmd, manage-inventory-custom-fields.qmd, and working-with-model-inventory.qmd for accuracy and clarity.