Release notes — December 24, 2024

[validbeck]

Internal Notes for Reviewers

sc-7721

December 24, 2024

LIVE PREVIEW

Minor updates

Backfilled old release notes with version

What it says on the tin — reorged some old releases so they were cleaner and clearly stated the version as good hygiene and practice in preparation for our potential upcoming versioned docs.

Manage custom reports

LIVE PREVIEW

Since they were referenced in the latest release:

• Added the sorting option for bar charts
• Added the count percentage for metrics (all visualizations)

Manage model inventory fields

LIVE PREVIEW

Since it was referenced in the latest release:

• Information about write permissions (based on info from https://github.com/validmind/frontend/pull/1092)

Customize documentation templates

LIVE PREVIEW

I fixed some of the old janky CSS that was still hanging out:

• Breadcrumb background was coloured
• Links were still blue in the top-level JSON schema
• Padding for the top-nav was narrow

Old	New

[github-actions]

PR Summary

This pull request introduces several enhancements and new features across the documentation and user interface of the ValidMind platform. Key changes include:

1. Documentation Enhancements:

   • Addition of new Jupyter Notebooks for option pricing in the Capital Markets section.
   • Introduction of a new FAQ section with updated information and new topics.
   • Launch of a Help Center for easier support access.
   • New login button on the documentation site for direct access to the ValidMind platform.

2. User Interface and Platform Enhancements:

   • Customizable dashboards and widgets for personalized user experience.
   • New features for managing model inventory and findings views.
   • Enhanced analytics settings with additional sorting and metric options.
   • Improved revision history display within content blocks.
   • Granular role permissions for inventory fields.

3. Bug Fixes:

   • Fixes related to the deletion of findings from validation reports.

These changes aim to improve user experience, streamline documentation processes, and enhance the overall functionality of the ValidMind platform.

Test Suggestions

• Verify the functionality of the new Jupyter Notebooks for option pricing.
• Test the new FAQ section for accuracy and completeness.
• Check the Help Center for accessibility and usability.
• Ensure the login button on the documentation site works correctly.
• Test the customization options for dashboards and widgets.
• Verify the new model inventory and findings views management features.
• Check the enhanced analytics settings for correct sorting and metric calculations.
• Test the improved revision history display for accuracy.
• Verify the role permissions for inventory fields are enforced correctly.
• Ensure findings are correctly removed from validation reports upon deletion.

[nrichers]

@validbeck we should get @mehdi0501 or designate to review this for messaging — in the meantime, I will take a look from the user guide perspective and I'm working on a tech deep dive blog post for dashboards to go with your release notes.

[github-actions]

PR Summary

This pull request introduces several enhancements and new features across the documentation and user interface of the ValidMind platform. Key changes include:

• Documentation Enhancements:

  • Addition of new Jupyter Notebooks for option pricing in the Capital Markets section.
  • Introduction of a new FAQ section and a Help Center for improved user support.
  • New login button on the documentation site for direct access to the ValidMind platform.
  • Updated branding and navigation for a cleaner, more intuitive user experience.

• Platform Enhancements:

  • Custom dashboards and widgets for personalized user experience.
  • New features for managing model inventory, including custom views and granular role permissions.
  • Improved analytics settings and revision history display.

• Bug Fixes:

  • Fixes related to findings deletion and UI improvements for a consistent user experience.

These changes aim to enhance user interaction with the platform, streamline documentation processes, and provide more robust support and customization options.

Test Suggestions

• Verify the functionality of the new login button on the documentation site.
• Test the creation and customization of dashboards and widgets.
• Check the new FAQ section for accuracy and completeness.
• Ensure the Help Center integration works as expected.
• Validate the new Jupyter Notebooks for option pricing are accessible and functional.
• Test the deletion process of findings to ensure they are removed from linked reports.

[github-actions]

A PR preview is available: Preview URL

[nrichers]

I'll let @mehdi or a designate approve these release notes but I just want to say that there's a ton in this release — thank you so much for putting together this amazing set of release notes, @validbeck! My comments mainly relate to where content should appear and about making sure the versioning is correct. 🤖

[github-actions]

A PR preview is available: Preview URL

[github-actions]

A PR preview is available: Preview URL

[github-actions]

A PR preview is available: Preview URL

[github-actions]

A PR preview is available: Preview URL

[validbeck]

@nrichers Compromise/edit after we talked:

• Kept some documentation highlights but any new notebook releases went into the ValidMind Library highlights
• Removed the versioning from the Documentation headers

I also shifted the date forward as it is no longer the 19th...

[github-actions]

PR Summary

This pull request introduces several enhancements and bug fixes across multiple files in the project. Key changes include:

1. Documentation Updates:

   • Added new release notes for December 24, 2024, highlighting new features such as custom dashboards, widgets, and enhanced reporting and analytics settings.
   • Updated various documentation files to improve clarity and organization, including the addition of new sections and improved navigation.
   • Introduced new Jupyter Notebooks for option pricing in the Capital Markets section.
   • Enhanced the FAQ section and introduced a new Help Center for better user support.

2. UI and Feature Enhancements:

   • Added the ability to manage saved views and customize dashboards within the platform.
   • Improved revision history display within content blocks and added granular role permissions for inventory fields.
   • Enhanced custom field management with Python support and added new content blocks for metrics over time.
   • Introduced new features for managing attachments in findings and defining attachment fields for model inventory.

3. Bug Fixes:

   • Fixed issues related to deleting findings from validation reports and improved scrollbar display on Windows.
   • Addressed bugs in template management and model inventory filters.

These changes aim to improve the user experience, enhance documentation clarity, and introduce new functionalities to the platform.

Test Suggestions

• Verify the new Jupyter Notebooks for option pricing are accessible and functional.
• Test the new custom dashboard and widget features for usability and performance.
• Check the updated FAQ and Help Center for accuracy and completeness.
• Ensure the new role permissions for inventory fields are correctly enforced.
• Validate the enhanced reporting and analytics settings for correct data visualization.
• Test the deletion of findings to ensure they are removed from linked validation reports.
• Check the UI for proper display of scrollbars on Windows environments.

[github-actions]

A PR preview is available: Preview URL

[nrichers]

LGTM!