validmind · github-actions · Dec 20, 2024 · Dec 20, 2024 · Dec 20, 2024
diff --git a/site/_quarto.yml b/site/_quarto.yml
@@ -170,6 +170,7 @@ website:
         - text: "---"
         - text: "Releases"
         # MAKE-RELEASE-NOTES-EMBED-MARKER
+        - releases/2024-dec-24/release-notes.qmd
         - releases/2024-dec-06/release-notes.qmd
         - releases/2024-oct-22/release-notes.qmd
         - releases/2024-sep-25/release-notes.qmd

diff --git a/site/about/overview-llm-features.qmd b/site/about/overview-llm-features.qmd
@@ -5,7 +5,6 @@ date: last-modified
 
 {{< var vm.product >}} offers several specialized features that use large language models (LLMs) to streamline model risk management and ensure regulatory compliance. Here's how we approach these features and what you need to know. 
 
-
 ::: {.attn}
 ## {{< fa list-check >}} Our philosophy
 

diff --git a/site/guide/model-documentation/customize-documentation-templates.qmd b/site/guide/model-documentation/customize-documentation-templates.qmd
@@ -74,8 +74,9 @@ The Bootstrap CSS from this HTML document hides the top navbar of our docs site
 
 <style>
 
-.container-fluid {
-  padding-left: 0px;
+.breadcrumb {
+  background-color: white;
+  padding: 0px;
 }
 
 .accordion > .card .card-header {
@@ -88,24 +89,31 @@ The Bootstrap CSS from this HTML document hides the top navbar of our docs site
   background-color: #de257e;
 }
 
+.badge.badge-dark {
+  color: #ffffff;
+  background-color: #083E44;
+}
+
 .btn.btn-link {
   font-size: 18px;
   user-select: text;
   text-decoration: none;
+  color: #de257e;
 }
 
 .btn.btn-link:hover {
-  color: #de257e;
+  color: #083E44;
+  /* text-decoration: underline 2px solid #083E44; */
 }
 
 a {
-  color: #DE257E;
+  color: #de257e;
   text-decoration: none;
 }
 
 a:hover {
   color: #DE257E;
-  text-decoration: underline black;
+  text-decoration: underline 2px solid #083E44;
 }
 
 </style>

diff --git a/site/guide/model-documentation/work-with-content-blocks.qmd b/site/guide/model-documentation/work-with-content-blocks.qmd
@@ -100,6 +100,10 @@ When generating content drafts with AI, accepted versions and edits are retained
 
 ## Remove content blocks
 
+::: {.callout-important}
+Test-driven or metric over time blocks can be re-added later on but **text blocks are currently deleted permanently**.
+:::
+
 1. In the left sidebar, click **{{< fa cubes >}} Inventory**.
 
 2. Select a model or find your model by applying a filter or searching for it.[^10]
@@ -123,10 +127,6 @@ When generating content drafts with AI, accepted versions and edits are retained
 
 6. After you confirm, the content block is removed. 
 
-   ::: {.callout-important}
-   Test-driven or metric over time blocks can be re-added later on but **text blocks are currently deleted permanently**.
-   :::
-
 ## What's next
 
 - [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)

diff --git a/site/guide/model-inventory/manage-model-inventory-fields.qmd b/site/guide/model-inventory/manage-model-inventory-fields.qmd
@@ -28,7 +28,8 @@ Create and edit the fields that appear on all models in your model inventory. Ch
 
 3. Fields require a [type]{.smallcaps},[^2] a [name]{.smallcaps}, and a [description]{.smallcaps}.
 
-    You can also choose to indicate that a field is **[required on registration]{.smallcaps}**.
+    - You can also choose to indicate that a field is **[required on registration]{.smallcaps}**.
+    - You can also assign **[write permissions]{.smallcaps}** to allow granular access to editing this field gated by roles.[^3]
 
 4. When you are satisfied with the setup of your field, click **Save**.
 
@@ -38,7 +39,7 @@ Single Line Text
 : Simple text value.
 
 Attachments
-: Upload supporting files for your model.[^3] Files must be less than 50 MB each in size.
+: Upload supporting files for your model.[^4] Files must be less than 50 MB each in size.
 
 Long Text
 : Toggle **Enable rich text formatting** to create a template using the rich text editor.
@@ -88,7 +89,7 @@ Email
 
 User
 : 
-- Select list pre-populated with users from your {{< fa book-open >}} User Directory.[^4] 
+- Select list pre-populated with users from your {{< fa book-open >}} User Directory.[^5] 
 - Toggle [allow linking to multiple records]{.smallcaps} on to allow multi-selection of users.
 
 Calculation <span id="calculation"></span> 
@@ -143,6 +144,19 @@ For example, say you have numeric model inventory fields of `materiality` and `c
 
 [^2]: [Inventory field types](#inventory-field-types)
 
-[^3]: [Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-supporting-documentation)
+[^3]: 
 
-[^4]: [Managing users](/guide/configuration/managing-users.qmd)
+    ::: {.callout title="Leave this field blank to leave permissions as default."}
+    - By default, model owners and validators have write access. 
+    - Model developers have read-only access. 
+
+    ::: {.tc}
+    [Manage permissions](/guide/configuration/manage-permissions.qmd){.button .button-green}
+
+    :::
+
+    :::
+
+[^4]: [Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd#manage-supporting-documentation)
+
+[^5]: [Managing users](/guide/configuration/managing-users.qmd)
diff --git a/site/guide/model-inventory/working-with-model-inventory.qmd b/site/guide/model-inventory/working-with-model-inventory.qmd
@@ -28,27 +28,22 @@ Get started with the {{< var vm.product >}} model inventory, which tracks compre
 
 ## Search, filter, and sort models
 
+:::{.callout}
+Changes are automatically saved and will affect only your account.
+:::
+
 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. 
 
 2. Use the top buttons to narrow down models and organize the model inventory to your preference:
    - **{{< fa magnifying-glass >}} Search** — Search for models using keywords.
    - **{{< fa filter >}} Filter** — Filter models by business units, developers, model tiering, model status, owners, use case, validators, or whether or not a model is a vendor model.
    - **{{< fa arrow-up-wide-short >}} Sort** — Sort results by different criteria such as name, business unit, use case, version, tier, status, creation date, or vendor name.
 
-:::{.callout}
-Changes are automatically saved and will affect only your account.
-:::
-
 ## What's next
 
 :::{#whats-next-listing}
 :::
 
-<!-- - [Customize model inventory layout](customize-model-inventory-layout.qmd)
-- [Edit model inventory fields](edit-model-inventory-fields.qmd)
-- [Manage model inventory fields](manage-model-inventory-fields.qmd) -->
-
-
 
 <!-- FOOTNOTES -->
 

diff --git a/site/guide/reporting/_reports-metrics.qmd b/site/guide/reporting/_reports-metrics.qmd
@@ -1,5 +1,5 @@
 [metrics]{.smallcaps}
 : The model or finding field that the visualization should retrieve data for: 
 
-- For `string` type fields, you can retrieve a `Count`.
-- For `number` type fields, you can retrieve any of the following: `Count`, `Sum`, `Average`, `Min`, `Max`
+- For `string` type fields, you can retrieve a `Count` or `Count %`.
+- For `number` type fields, you can retrieve any of the following: `Count`, `Count %`, `Sum`, `Average`, `Min`, `Max`
diff --git a/site/guide/reporting/manage-custom-reports.qmd b/site/guide/reporting/manage-custom-reports.qmd
@@ -22,6 +22,9 @@ Add, edit, or remove custom data to your analytics within the {{< var validmind.
 
 {{< include _reports-filtering.qmd >}}
 
+[sorting]{.smallcaps}
+: Sort your data by your chosen metric or grouping in descending or ascending order.
+
 [bar chart grouping style]{.smallcaps}
 : Configure how the groupings are displayed:
 

diff --git a/site/index.qmd b/site/index.qmd
@@ -45,12 +45,12 @@ listing:
     sort: false
     fields: [title, description]
     contents:
-      - 2024-dec-06/release-notes.qmd
-      - 2024-oct-22/release-notes.qmd
-      - 2024-sep-25/release-notes.qmd
-      - 2024-sep-09/release-notes.qmd
-      - 2024-aug-13/release-notes.qmd
-      - 2024-jul-22/release-notes.qmd
+      - /releases/2024-dec-24/release-notes.qmd
+      - /releases/2024-dec-06/release-notes.qmd
+      - /releases/2024-oct-22/release-notes.qmd
+      - /releases/2024-sep-25/release-notes.qmd
+      - /releases/2024-sep-09/release-notes.qmd
+      - /releases/2024-aug-13/release-notes.qmd
   - id: validmind-academy
     type: grid
     image-height: 200px

diff --git a/site/python-docs.zip b/site/python-docs.zip
diff --git a/site/releases/2023/2023-aug-15/highlights.qmd b/site/releases/2023/2023-aug-15/highlights.qmd
@@ -17,7 +17,7 @@ This release includes a number of improvements for the developer experience when
 
 We made a number of enhancements to the {{< var validmind.developer >}} to improve the experience for developers.
 
-**Better test organization**
+##### Better test organization
 
 :::: {.flex .flex-wrap .justify-around}
 
@@ -32,7 +32,7 @@ Added a `metadata` and `tags` attribute to the `Test` base class for better cate
 
 ::::
 
-**Better filtering**
+##### Better filtering
 
 :::: {.flex .flex-wrap .justify-around}
 
@@ -49,7 +49,7 @@ Added a new `task_type` argument to the `list_tests()` function to allow simple
 ::::
 
 
-**Clearer naming**
+##### Clearer naming
 
 Renamed `required_context` to `required_inputs` across the whole {{< var vm.product >}} {{< var validmind.api >}}.
 
@@ -58,7 +58,7 @@ Renamed `required_context` to `required_inputs` across the whole {{< var vm.prod
 
 To make the discovery of required context and default configuration easier, this update includes a number of changes to how `required_context` and `default_parameters` are presented.
 
-**Preview template expansion**
+##### Preview template expansion
 
 :::: {.flex .flex-wrap .justify-around}
 
@@ -74,7 +74,7 @@ With `vm.preview_template()`, you can now view detailed, expandable information
 
 ::::
 
-**Simplified test listing**
+##### Simplified test listing
 
 :::: {.flex .flex-wrap .justify-around}
 
@@ -90,7 +90,7 @@ The `vm.tests.list_tests()` function has been refined to show only the `ID`, `Na
 
 ::::
 
-**Detailed test descriptions**
+##### Detailed test descriptions
 
 :::: {.flex .flex-wrap .justify-around}
 
@@ -106,7 +106,7 @@ You can now obtain complete test details, including `required_context` and `defa
 
 ::::
 
-**Retrieve test suite**
+##### Retrieve test suite
 
 :::: {.flex .flex-wrap .justify-around}
 
@@ -122,7 +122,7 @@ The new function `vm.get_test_suite()` allows you to access a specific test suit
 
 ::::
 
-**Access to default configuration**
+##### Access to default configuration
 
 :::: {.flex .flex-wrap .justify-around}
 
@@ -138,7 +138,7 @@ A new method, `get_default_config()`, is now part of both the TestPlan and TestS
 
 ::::
 
-**Easier required context**
+##### Easier required context
 
 :::: {.flex .flex-wrap .justify-around}
 

diff --git a/site/releases/2023/2023-dec-13/highlights.qmd b/site/releases/2023/2023-dec-13/highlights.qmd
@@ -6,13 +6,16 @@ title: "December 13, 2023"
 
 ## {{< fa bullhorn >}} Release highlights
 
+### {{< var validmind.platform >}} (v1.10.0)
+
 This release includes bug fixes for the {{< var validmind.platform >}} and reduces the external dependencies for our user-facing documentation site. 
 
 :::
 
-
 ## Bug fixes 
 
+### {{< var validmind.platform >}} (v1.10.0)
+
 <!---Makes author's name contextual to currently logged user by @gtagle in [#492](https://github.com/validmind/frontend/pull/492)--->
 #### Contextualized references to the current user
 We fixed an issue where activity logs indicated user references out of context, displaying the current user's full name instead of referring to them as "you".
@@ -21,7 +24,9 @@ We fixed an issue where activity logs indicated user references out of context,
 #### Respect width and height for plots when available
 We fixed an issue where some plots were being cut off due to having more height than available in the current viewport. This issue was fixed by respecting the plot's original defined height instead of setting a maximum pre-configured height on the frontend.
 
-## Documentation updates
+## Documentation
+
+### Site enhancements
 
 <!---Remove safe external dependencies by @nrichers in [#147](https://github.com/validmind/documentation/pull/147)--->
 #### Removed safe external dependencies

diff --git a/site/releases/2023/2023-nov-09/highlights.qmd b/site/releases/2023/2023-nov-09/highlights.qmd
@@ -132,14 +132,16 @@ You can easily switch between views using the **Display Table** or **Display Car
 :::
 
 
-## Documentation updates
+## Documentation
 
-### Enhanced test descriptions 
+### Site enhancements
+
+#### Improved test descriptions 
 <!---Better test descriptions by @nrichers in [#144](https://github.com/validmind/documentation/pull/144)--->
 
 :::: {.flex .flex-wrap .justify-around}
 
-::: {.w-60-ns}
+::: {.w-70-ns .pr2}
 - We have improved the descriptions for tests available in the {{< var validmind.developer >}}, together with a new landing page that allows for easy browsing of all tests. 
 - Additionally, our documentation site search now indexes these descriptions to make them easier to find. 
 :::
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,7 +5,6 @@ date: last-modified

		{{< var vm.product >}} offers several specialized features that use large language models (LLMs) to streamline model risk management and ensure regulatory compliance. Here's how we approach these features and what you need to know.


		::: {.attn}
		## {{< fa list-check >}} Our philosophy

Expand Down