validmind · validbeck · Aug 15, 2024 · Aug 8, 2024 · Aug 8, 2024 · Aug 8, 2024
diff --git a/internal/templates/task.qmd b/internal/templates/task.qmd
@@ -1,34 +1,36 @@
 ---
-title: "[Task Title]"
+title: "Task Title"
 date: last-modified
 ---

 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed faucibus, urna vel dignissim fringilla, est justo rhoncus ex, nec gravida eros nisl a nisi. Suspendisse potenti. 

 [Include a brief description of what this task is about and why it's important.]

+::: {.prereq}
+
 ## Prerequisites

-[Include a list of any prerequisites the user needs to complete before starting the task, such as user roles they need to hold, software prerequisites, access to certain resources, or completing previous tasks.]
+- [x] {{< var link.login >}}
+- [x] Include the rest of the list of any prerequisites the user needs to complete before starting the task, such as user roles they need to hold, software prerequisites, access to certain resources, or completing previous tasks.

-## Steps
+:::

-<!-- STEP ONE BELOW IS LOGIN TO THE VM, REPLACE IF NECESSARY -->
+## Steps

-1. {{< var link.login >}}
-2. [Step 2]
-   - [Include any sub-steps or details needed to complete this step]
-3. [Step 3]
-   - [Include any sub-steps or details needed to complete this step]
-   - [If applicable, include screenshots or images to illustrate the step]
-4. [Step 4]
-   - [Include any sub-steps or details needed to complete this step]
+1. Step 2
+   - Include any sub-steps or details needed to complete this step
+2. Step 3
+   - Include any sub-steps or details needed to complete this step
+   - If applicable, include screenshots or images to illustrate the step
+3. Step 4
+   - Include any sub-steps or details needed to complete this step]

 ## Troubleshooting

-[Include any common issues or errors that may arise during the task and how to resolve them.]
+Include any common issues or errors that may arise during the task and how to resolve them.

 ## What's next

-[Summarize the task and provide any next steps or resources for the user to continue their learning or work.]
+Summarize the task and provide any next steps or resources for the user to continue their learning or work.

diff --git a/site/_site/about/contributing/style-guide/conventions.html b/site/_site/about/contributing/style-guide/conventions.html
@@ -6,7 +6,7 @@

 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

-<meta name="dcterms.date" content="2024-08-14">
+<meta name="dcterms.date" content="2024-08-15">

 <title>Conventions – ValidMind</title>
 <style>
@@ -528,7 +528,7 @@ <h1 class="title">Conventions</h1>
    <div>
    <div class="quarto-title-meta-heading">Published</div>
    <div class="quarto-title-meta-contents">
-      <p class="date">August 14, 2024</p>
+      <p class="date">August 15, 2024</p>
    </div>
  </div>

@@ -725,7 +725,7 @@ <h3 class="anchored" data-anchor-id="margin-footnotes">Margin footnotes</h3>
 <span id="cb4-12"><a href="#cb4-12" aria-hidden="true" tabindex="-1"></a></span>
 <span id="cb4-13"><a href="#cb4-13" aria-hidden="true" tabindex="-1"></a><span class="ot">[^3]: </span><span class="co">[</span><span class="ot">Working with model workflows</span><span class="co">](set-up-model-workflows.qmd)</span></span>
 <span id="cb4-14"><a href="#cb4-14" aria-hidden="true" tabindex="-1"></a></span>
-<span id="cb4-15"><a href="#cb4-15" aria-hidden="true" tabindex="-1"></a><span class="ot">[^4]: </span><span class="co">[</span><span class="ot">Managing users (Supported roles)</span><span class="co">](/guide/configuration/managing-users.qmd#supported-roles)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div></li>
+<span id="cb4-15"><a href="#cb4-15" aria-hidden="true" tabindex="-1"></a><span class="ot">[^4]: </span><span class="co">[</span><span class="ot">Manage permissions</span><span class="co">](/guide/configuration/manage-permissions.qmd)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div></li>
 </ul>
 <div class="no-row-height column-margin column-container"><div id="fn4"><p><sup>4</sup>&nbsp;<strong>Quarto:</strong> <a href="https://quarto.org/docs/authoring/markdown-basics.html#footnotes">Footnotes</a></p></div></div><p>Footnotes will automatically appear in the correct location in the margin.</p>
 <table class="table-hover caption-top table">

diff --git a/site/_site/about/contributing/style-guide/style-guide.html b/site/_site/about/contributing/style-guide/style-guide.html
@@ -549,7 +549,7 @@ <h5 class="no-anchor card-title listing-title">
 </div>
 </a>
 </div>
-<div class="g-col-1" data-index="1" data-listing-date-sort="1723648796000" data-listing-file-modified-sort="1723648796901" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="11" data-listing-word-count-sort="2030">
+<div class="g-col-1" data-index="1" data-listing-date-sort="1723763069000" data-listing-file-modified-sort="1723763069374" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="11" data-listing-word-count-sort="2028">
 <a href="../../../about/contributing/style-guide/conventions.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">

diff --git a/site/_site/about/glossary/glossary.html b/site/_site/about/glossary/glossary.html
@@ -6,7 +6,7 @@

 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

-<meta name="dcterms.date" content="2024-08-14">
+<meta name="dcterms.date" content="2024-08-15">

 <title>Glossary – ValidMind</title>
 <style>
@@ -463,7 +463,7 @@ <h1 class="title">Glossary</h1>
    <div>
    <div class="quarto-title-meta-heading">Published</div>
    <div class="quarto-title-meta-contents">
-      <p class="date">August 14, 2024</p>
+      <p class="date">August 15, 2024</p>
    </div>
  </div>


diff --git a/site/_site/about/overview-model-documentation.html b/site/_site/about/overview-model-documentation.html
@@ -6,7 +6,7 @@

 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

-<meta name="dcterms.date" content="2024-08-14">
+<meta name="dcterms.date" content="2024-08-15">

 <title>Automated model testing &amp; documentation – ValidMind</title>
 <style>
@@ -466,7 +466,7 @@
    <h2 id="toc-title">On this page</h2>

  <ul>
-  <li><a href="#the" id="toc-the" class="nav-link active" data-scroll-target="#the">The ValidMind Developer Framework</a></li>
+  <li><a href="#the" id="toc-the" class="nav-link active" data-scroll-target="#the"><i class="fa-solid fa-code" aria-label="code"></i> The ValidMind Developer Framework</a></li>
  <li><a href="#simple-installation" id="toc-simple-installation" class="nav-link" data-scroll-target="#simple-installation">Simple installation</a></li>
  <li><a href="#docs-as-code" id="toc-docs-as-code" class="nav-link" data-scroll-target="#docs-as-code">Docs-as-code</a></li>
  <li><a href="#extensible-by-design" id="toc-extensible-by-design" class="nav-link" data-scroll-target="#extensible-by-design">Extensible by design</a></li>
@@ -491,7 +491,7 @@ <h1 class="title">Automated model testing &amp; documentation</h1>
    <div>
    <div class="quarto-title-meta-heading">Published</div>
    <div class="quarto-title-meta-contents">
-      <p class="date">August 14, 2024</p>
+      <p class="date">August 15, 2024</p>
    </div>
  </div>

@@ -511,8 +511,8 @@ <h1 class="title">Automated model testing &amp; documentation</h1>
 ### Closed beta: LLM testing & documentation
 --->
 <p>The ValidMind Developer Framework streamlines the process of documenting various types of models. The developer framework automates the documentation process, ensuring that your model documentation and testing aligns with regulatory and compliance standards.</p>
-<section id="the" class="level2">
-<h2 class="anchored" data-anchor-id="the">The ValidMind Developer Framework</h2>
+<section id="the" class="level2 prereq">
+<h2 class="anchored" data-anchor-id="the"><i class="fa-solid fa-code" aria-label="code"></i> The ValidMind Developer Framework</h2>
 <p>The ValidMind Developer Framework is a developer framework and documentation engine designed to streamline the process of documenting various types of models, including traditional statistical models, legacy systems, artificial intelligence/machine learning models, and large language models (LLMs). It offers model developers a systematic approach to documenting and testing risk models with repeatability and consistency, ensuring alignment with regulatory and compliance standards.</p>
 <!-- Using the variable in alt text messes up the image display  -->
 <div class="quarto-figure quarto-figure-center">

diff --git a/site/_site/about/overview-model-risk-management.html b/site/_site/about/overview-model-risk-management.html
@@ -6,7 +6,7 @@

 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

-<meta name="dcterms.date" content="2024-08-14">
+<meta name="dcterms.date" content="2024-08-15">

 <title>Model risk management – ValidMind</title>
 <style>
@@ -432,7 +432,7 @@
    <h2 id="toc-title">On this page</h2>

  <ul>
-  <li><a href="#the" id="toc-the" class="nav-link active" data-scroll-target="#the">The ValidMind Platform UI</a></li>
+  <li><a href="#the" id="toc-the" class="nav-link active" data-scroll-target="#the"><i class="fa-solid fa-laptop-code" aria-label="laptop-code"></i> The ValidMind Platform UI</a></li>
  <li><a href="#regulatory-requirements" id="toc-regulatory-requirements" class="nav-link" data-scroll-target="#regulatory-requirements">Regulatory requirements</a>
  <ul class="collapse">
  <li><a href="#around-the-globe" id="toc-around-the-globe" class="nav-link" data-scroll-target="#around-the-globe">Around the globe</a></li>
@@ -458,7 +458,7 @@ <h1 class="title">Model risk management</h1>
    <div>
    <div class="quarto-title-meta-heading">Published</div>
    <div class="quarto-title-meta-contents">
-      <p class="date">August 14, 2024</p>
+      <p class="date">August 15, 2024</p>
    </div>
  </div>

@@ -479,8 +479,8 @@ <h1 class="title">Model risk management</h1>
 ### Reporting
 --->
 <p>The ValidMind Platform UI offers an integrated platform to manage validation reports, track findings, and report on model risk compliance across your model portfolio. The platform UI enables your organization to monitor and manage models effectively, focusing on mitigating risks, maintaining governance, and ensuring compliance throughout the entire enterprise.</p>
-<section id="the" class="level2">
-<h2 class="anchored" data-anchor-id="the">The ValidMind Platform UI</h2>
+<section id="the" class="level2 prereq">
+<h2 class="anchored" data-anchor-id="the"><i class="fa-solid fa-laptop-code" aria-label="laptop-code"></i> The ValidMind Platform UI</h2>
 <p>The ValidMind Platform UI provides a comprehensive suite of tools, guidelines, and best practices. You use the platform to review and evaluate models and model documentation to ensure they comply with organizational and regulatory requirements.</p>
 <!-- Using the variable in alt text messes up the image display  -->
 <div class="quarto-figure quarto-figure-center">

diff --git a/site/_site/about/overview.html b/site/_site/about/overview.html
@@ -583,7 +583,7 @@ <h1 class="title">About ValidMind</h1>
 <h2 class="anchored" data-anchor-id="section">ValidMind AI risk platform</h2>
 <div id="listing-validmind-features" class="quarto-listing quarto-listing-container-grid">
 <div class="list grid quarto-listing-cols-2">
-<div class="g-col-1" data-index="0" data-listing-date-sort="1723648796000" data-listing-file-modified-sort="1723648796902" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="5" data-listing-word-count-sort="835">
+<div class="g-col-1" data-index="0" data-listing-date-sort="1723763069000" data-listing-file-modified-sort="1723763069375" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="5" data-listing-word-count-sort="840">
 <a href="../about/overview-model-documentation.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">
@@ -597,7 +597,7 @@ <h5 class="no-anchor card-title listing-title">
 </div>
 </a>
 </div>
-<div class="g-col-1" data-index="1" data-listing-date-sort="1723648796000" data-listing-file-modified-sort="1723648796902" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="8" data-listing-word-count-sort="1475">
+<div class="g-col-1" data-index="1" data-listing-date-sort="1723763069000" data-listing-file-modified-sort="1723763069375" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="8" data-listing-word-count-sort="1480">
 <a href="../about/overview-model-risk-management.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">

diff --git a/site/_site/developer/get-started-developer-framework.html b/site/_site/developer/get-started-developer-framework.html
@@ -1972,7 +1972,7 @@ <h2 class="anchored" data-anchor-id="getting-started">Getting started</h2>
 <p>After you <a href="https://app.prod.validmind.ai"><strong>sign up</strong></a> for ValidMind to get access, try one our getting started guide:</p>
 <div id="listing-developer-getting-started" class="quarto-listing quarto-listing-container-grid">
 <div class="list grid quarto-listing-cols-3">
-<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1723741719292" data-listing-reading-time-sort="10" data-listing-word-count-sort="1928">
+<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1723764470190" data-listing-reading-time-sort="10" data-listing-word-count-sort="1928">
 <a href="../notebooks/quickstart_customer_churn_full_suite.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">
@@ -1986,7 +1986,7 @@ <h5 class="no-anchor card-title listing-title">
 </div>
 </a>
 </div>
-<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1723741719292" data-listing-reading-time-sort="27" data-listing-word-count-sort="5344">
+<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1723764470190" data-listing-reading-time-sort="27" data-listing-word-count-sort="5344">
 <a href="../notebooks/tutorials/intro_for_model_developers.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">
@@ -2011,7 +2011,7 @@ <h2 class="anchored" data-anchor-id="learn-how-to-run-tests">Learn how to run te
 <p>ValidMind provides many built-in tests and test suites which make it easy for developers to automate their model documentation. Start by running a pre-made test, then modify it, and finally create your own test:</p>
 <div id="listing-developer-how-to-beginner" class="quarto-listing quarto-listing-container-grid">
 <div class="list grid quarto-listing-cols-3">
-<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1723741719290" data-listing-reading-time-sort="9" data-listing-word-count-sort="1796">
+<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1723764470187" data-listing-reading-time-sort="9" data-listing-word-count-sort="1796">
 <a href="../notebooks/how_to/run_tests/1_run_dataset_based_tests.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">
@@ -2025,7 +2025,7 @@ <h5 class="no-anchor card-title listing-title">
 </div>
 </a>
 </div>
-<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1723741719270" data-listing-reading-time-sort="14" data-listing-word-count-sort="2776">
+<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1723764470160" data-listing-reading-time-sort="14" data-listing-word-count-sort="2776">
 <a href="../notebooks/code_samples/custom_tests/implement_custom_tests.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">
@@ -2051,7 +2051,7 @@ <h2 class="anchored" data-anchor-id="try-the-code-samples">Try the code samples<
 <p>Our code samples showcase the capabilities of the ValidMind Developer Framework. Examples that you can build on and adapt for your own use cases include:</p>
 <div id="listing-developer-code-samples" class="quarto-listing quarto-listing-container-grid">
 <div class="list grid quarto-listing-cols-3">
-<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1723741719270" data-listing-reading-time-sort="16" data-listing-word-count-sort="3018">
+<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1723764470160" data-listing-reading-time-sort="16" data-listing-word-count-sort="3018">
 <a href="../notebooks/code_samples/customization/customizing_tests_with_output_templates.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">
@@ -2065,7 +2065,7 @@ <h5 class="no-anchor card-title listing-title">
 </div>
 </a>
 </div>
-<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1723741719283" data-listing-reading-time-sort="8" data-listing-word-count-sort="1418">
+<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1723764470182" data-listing-reading-time-sort="8" data-listing-word-count-sort="1418">
 <a href="../notebooks/code_samples/nlp_and_llm/prompt_validation_demo.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">
@@ -2079,7 +2079,7 @@ <h5 class="no-anchor card-title listing-title">
 </div>
 </a>
 </div>
-<div class="g-col-1" data-index="2" data-listing-file-modified-sort="1723741719286" data-listing-reading-time-sort="11" data-listing-word-count-sort="2094">
+<div class="g-col-1" data-index="2" data-listing-file-modified-sort="1723764470184" data-listing-reading-time-sort="11" data-listing-word-count-sort="2094">
 <a href="../notebooks/code_samples/time_series/quickstart_time_series_full_suite.html" class="quarto-grid-link">
 <div class="quarto-grid-item card h-100 card-left">
 <div class="card-body post-contents">

diff --git a/site/_site/developer/model-documentation/install-and-initialize-developer-framework.html b/site/_site/developer/model-documentation/install-and-initialize-developer-framework.html
@@ -6,7 +6,7 @@

 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

-<meta name="dcterms.date" content="2024-08-14">
+<meta name="dcterms.date" content="2024-08-15">

 <title>Install and initialize the developer framework – ValidMind</title>
 <style>
@@ -1765,7 +1765,7 @@ <h1 class="title">Install and initialize the developer framework</h1>
    <div>
    <div class="quarto-title-meta-heading">Published</div>
    <div class="quarto-title-meta-contents">
-      <p class="date">August 14, 2024</p>
+      <p class="date">August 15, 2024</p>
    </div>
  </div>

@@ -1778,8 +1778,21 @@ <h1 class="title">Install and initialize the developer framework</h1>


 <p>ValidMind generates a unique <em>code snippet</em> for each registered model to connect with your developer environment. You initialize the client library with this code snippet, which ensures that your documentation and tests are uploaded to the correct model when you run a Jupyter notebook.</p>
-<section id="prerequisites" class="level2 page-columns page-full">
+<section id="prerequisites" class="level2 prereq page-columns page-full">
 <h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
+<div class="callout callout-style-simple callout-none no-icon callout-titled" title="Before you begin">
+<div class="callout-header d-flex align-content-center">
+<div class="callout-icon-container">
+<i class="callout-icon no-icon"></i>
+</div>
+<div class="callout-title-container flex-fill">
+Before you begin
+</div>
+</div>
+<div class="callout-body-container callout-body">
+<p>Make sure you are logged in to the <a href="../../guide/configuration/log-in-to-validmind.html">ValidMind Platform UI <i class="fa-solid fa-hand-point-right" aria-label="hand-point-right"></i></a>.</p>
+</div>
+</div>
 <p>In order to integrate the developer framework and to be able to upload to the platform UI, you must provide the following information through a code snippet that you copy from the ValidMind Platform UI:</p>
 <table class="caption-top table">
 <thead>
@@ -1814,7 +1827,6 @@ <h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
 <h2 class="anchored" data-anchor-id="locate-the-integration-instructions">Locate the developer framework integration instructions</h2>
 <p>For existing projects, this information can be found in the ValidMind Platform UI:</p>
 <ol type="1">
-<li><p><a href="../../guide/configuration/log-in-to-validmind.html">Log in to ValidMind</a>.</p></li>
 <li><p>In the left sidebar, click <strong>Model Inventory</strong>.</p></li>
 <li><p>Select a model by clicking on it or find your model by applying a filter or searching for it.<a href="#fn2" class="footnote-ref" id="fnref2" role="doc-noteref"><sup>2</sup></a></p></li>
 <li><p>In the left sidebar that appears for your model, click <strong>Getting Started</strong>.</p></li>