@gtagle @even-steven Can I get your accuracy check on this new doc? 🙏🏻

https://docs-demo.vm.validmind.ai/pr_previews/beck/sc-6346/documentation-support-displaying-results/guide/monitoring/work-with-metrics-over-time.html

If it looks good to you, Nik has requested that someone product/development side approve to reduce bottle-necking for PRs.

PR Summary

This pull request introduces several enhancements to the documentation related to monitoring and metrics over time in the ValidMind platform. The key changes include:

1. New Documentation for Metrics Over Time: A new guide titled work-with-metrics-over-time.qmd has been added. This guide provides detailed instructions on how to view and add metrics over time to ongoing monitoring plans. It covers prerequisites, steps to add metrics, and how to view metadata associated with these metrics.

2. Updates to Existing Documentation:

   • Model Documentation: Various updates have been made to the work-with-test-results.qmd, work-with-content-blocks.qmd, and _add-content-block.qmd files to include references to metrics over time and improve clarity.
   • Monitoring Guides: The enable-monitoring.qmd and review-monitoring-results.qmd files have been updated to reflect changes in the process of enabling and reviewing monitoring results.
   • Navigation and Structure: The _quarto.yml file has been updated to include the new metrics over time guide in the navigation structure.

3. Minor Text and Formatting Adjustments: Several minor text changes and formatting adjustments have been made across various documentation files to improve readability and accuracy.

4. New Images and GIFs: New images and GIFs have been added to illustrate the process of adding and viewing metrics over time.

Test Suggestions

• Verify that the new 'Work with metrics over time' guide is accessible from the navigation menu and displays correctly.
• Test the process of adding metrics over time as described in the new guide to ensure the instructions are accurate and complete.
• Check all updated documentation files for broken links or missing images.
• Ensure that the new images and GIFs are displayed correctly and enhance the understanding of the documentation.
• Review the changes in the _quarto.yml file to confirm that the navigation structure is updated correctly.

PR Summary

This pull request introduces several enhancements to the monitoring documentation and the handling of metrics over time within the ValidMind platform. The key changes include:

1. New Documentation for Metrics Over Time:

   • Added a new guide work-with-metrics-over-time.qmd that provides detailed instructions on how to add and view metrics over time in the ongoing monitoring plans.
   • This guide includes prerequisites, steps to add metrics, and how to view metadata associated with these metrics.

2. Updates to Existing Documentation:

   • Updated various documentation files to include references to the new metrics over time feature.
   • Enhanced descriptions and instructions for adding content blocks, including the new metric over time blocks.
   • Improved clarity and consistency in the instructions for working with test results and ongoing monitoring.

3. Configuration Changes:

   • Updated _quarto.yml to include the new metrics over time guide in the monitoring section.
   • Modified ongoing-monitoring.qmd to include the new guide in the listing of ongoing monitoring resources.

4. Minor Fixes and Improvements:

   • Corrected some terminology and improved the clarity of instructions in various documentation files.
   • Updated image alt texts and descriptions for better accessibility and understanding.

These changes aim to enhance the user experience by providing clearer and more comprehensive documentation for monitoring and metrics over time features.

Test Suggestions

• Verify that the new 'Work with metrics over time' guide is accessible from the monitoring section.
• Check that all links and references to the new metrics over time feature are working correctly.
• Ensure that the instructions for adding and viewing metrics over time are clear and accurate.
• Test the process of adding a metric over time block to the documentation and verify that it functions as described.
• Review the updated image alt texts and descriptions for accuracy and clarity.

PR Summary

This pull request introduces several enhancements to the monitoring documentation and the addition of a new feature for working with metrics over time. The key changes include:

1. New Documentation for Metrics Over Time:

   • Added a new guide work-with-metrics-over-time.qmd that explains how to view and add metrics over time to ongoing monitoring plans.
   • This guide includes steps for adding metrics, viewing metadata, and understanding the importance of tracking model performance over time.

2. Updates to Existing Documentation:

   • Updated various documentation files to include references to the new metrics over time feature.
   • Improved clarity and consistency in the instructions for adding and managing content blocks, including test-driven and metric over time blocks.
   • Enhanced the descriptions and instructions for enabling ongoing monitoring and reviewing monitoring results.

3. UI and Content Adjustments:

   • Adjusted the UI elements and instructions to reflect the new options available for metrics over time.
   • Updated screenshots and GIFs to showcase the new features and improved user interface.

4. Minor Corrections and Improvements:

   • Fixed typos and improved the readability of the documentation.
   • Ensured that all references and links are up-to-date and accurate.

These changes aim to provide better guidance for users on how to effectively monitor their models and utilize the new metrics over time feature.

Test Suggestions

• Verify that the new 'Work with metrics over time' guide is accessible and renders correctly.
• Test the process of adding a metric over time block to model documentation and ongoing monitoring plans.
• Ensure that the updated instructions for enabling ongoing monitoring are clear and functional.
• Check that all links and references in the documentation are correct and lead to the appropriate sections.
• Validate that the UI elements and screenshots match the described steps in the documentation.

@johnwalz97 Can you accuracy check this new doc for the explanation as to why metrics over time are relevant/used?

https://docs-demo.vm.validmind.ai/pr_previews/beck/sc-6346/documentation-support-displaying-results/guide/monitoring/work-with-metrics-over-time.html

PR Summary

This pull request introduces several enhancements to the monitoring documentation and the addition of a new feature for working with metrics over time. The key changes include:

1. New Documentation for Metrics Over Time:

   • Added a new guide work-with-metrics-over-time.qmd that explains how to view and add metrics over time to ongoing monitoring plans.
   • This guide includes steps for adding metrics, viewing metadata, and ensuring the accuracy of the data.

2. Updates to Existing Documentation:

   • Updated various documentation files to include references to the new metrics over time feature.
   • Improved clarity and consistency in the instructions for adding and managing content blocks, test results, and ongoing monitoring.
   • Enhanced descriptions and instructions for using the ValidMind platform, including better explanations for roles and permissions.

3. UI Enhancements:

   • Updated the _quarto.yml configuration to include the new metrics over time guide in the monitoring section.
   • Improved the layout and navigation within the monitoring documentation by adding new entries and updating existing ones.

4. Minor Fixes and Improvements:

   • Corrected typos and improved the readability of several documentation files.
   • Updated image alt texts and descriptions for better accessibility and clarity.

These changes aim to provide a more comprehensive and user-friendly experience for developers and validators working with the ValidMind platform's monitoring features.

Test Suggestions

• Verify that the new 'Metrics over time' guide is accessible from the monitoring section in the documentation.
• Test the steps outlined in the 'work-with-metrics-over-time.qmd' guide to ensure they are accurate and functional.
• Check that all links and references to the new metrics over time feature are working correctly.
• Ensure that the updated instructions for adding content blocks, test results, and ongoing monitoring are clear and accurate.
• Validate that the UI changes in _quarto.yml correctly reflect the new documentation structure.

A PR preview is available: Preview URL