Documentation for filtering test result metadata

[validbeck]

Internal Notes for Reviewers

sc-6911

Work with test results

Added a new sub-section under View test result metadata to reflect the new filtering option:

• Gif has been updated to reflect the new UI
• There is a commented out section for "pinning" historical test results for when that is ready to be exposed to end-users

[validbeck]

@lucaspazneutech If these instructions look good to you, can you please approve? 🙏🏻

LIVE PREVIEW

[github-actions]

PR Summary

This pull request introduces several enhancements to the documentation and styling of the project:

1. Documentation Enhancements:

   • Added a section on filtering historical test results in the work-with-test-results.qmd file. Users can now filter test results by date range, model, dataset, and the person who ran the test.
   • Updated instructions for resolving comments and suggested changes in the collaborate-with-others.qmd and _collaborate-with-others-comments.qmd files to use a more consistent styling approach.
   • Clarified the process of filtering model findings in the view-filter-model-findings.qmd file.

2. Styling Updates:

   • Introduced new CSS classes in styles.css for consistent styling of text and backgrounds, including .green-bg, .pink, .green, and .red.
   • Updated the index page to use the new .pink class for styling text.

These changes aim to improve the usability and visual consistency of the documentation, making it easier for users to navigate and understand the available features.

Test Suggestions

• Verify that the new filtering functionality in the documentation is correctly described and matches the actual application behavior.
• Check that the new CSS classes are applied correctly across the documentation and that they render as expected in different browsers.
• Ensure that the updated instructions for resolving comments and suggested changes are clear and accurate.
• Test the documentation site to ensure that all links and images are functioning correctly after the updates.

[github-actions]

PR Summary

This pull request introduces several enhancements to the documentation of the project:

1. Test Result Filtering: Added functionality to filter historical test results based on criteria such as date range, model, dataset, and run by. This allows users to narrow down test runs and manage test result metadata more effectively.

2. Styling Updates: Introduced new CSS classes for consistent styling across the documentation. These include .green-bg for background highlighting, and .green, .red, and .pink for text color styling. These changes improve the visual clarity and consistency of the documentation.

3. Documentation Improvements: Updated various documentation files to use the new styling classes for better readability and user experience. This includes changes in how suggested changes and comments are displayed and resolved.

Overall, these changes aim to enhance the usability and visual appeal of the documentation, making it easier for users to interact with and understand the content.

Test Suggestions

• Verify that the filtering functionality for test results works as expected with various criteria.
• Check that the new CSS classes are applied correctly across different documentation pages.
• Ensure that the documentation displays correctly in different browsers and screen sizes.
• Test the interaction with the test result metadata to confirm that filters can be applied and removed without issues.
• Review the documentation for any visual inconsistencies or errors introduced by the new styling.

[lucaspazneutech]

All good here!

[github-actions]

A PR preview is available: Preview URL