Update validation report user guide & tweak model documentation landing page

site/_quarto.yml

@@ -38,7 +38,7 @@ website:
         - text: "---"
         - text: "{{< fa code >}} CODE SAMPLES"
         - text: "{{< fa book >}} QuickStart · `Customer Churn` · `Binary Classification`"
-          file: ./notebooks/quickstart_customer_churn_full_suite.ipynb
+          file: notebooks/quickstart_customer_churn_full_suite.ipynb
         - text: "{{< fa book-open-reader >}} More Code Samples · `LLM` · `NLP` · `Time Series` · `Etc.`"
           file: guide/samples-jupyter-notebooks.qmd
         - text: "{{< fa download >}} Download Code Samples · `notebooks.zip`"
@@ -150,8 +150,8 @@ website:
           contents:
           - guide/view-documentation-guidelines.qmd
           - guide/work-with-content-blocks.qmd
+          - guide/collaborate-with-others.qmd
           - guide/view-documentation-activity.qmd
-          - guide/comment-on-documentation.qmd
           - guide/submit-for-approval.qmd
         - guide/export-documentation.qmd
         - text: "---"
@@ -161,8 +161,9 @@ website:
         - file: guide/preparing-validation-reports.qmd
           contents:
           - guide/view-validation-guidelines.qmd
-          - guide/collaborate-on-documentation.qmd
-#          - guide/link-to-evidence.qmd
+          - guide/assess-compliance.qmd
+          - guide/work-with-content-blocks.qmd
+          - guide/collaborate-with-others.qmd
           - guide/submit-for-approval.qmd
         - guide/work-with-model-findings.qmd
         - guide/view-reports.qmd

site/_site/guide/link-to-evidence.html → site/_site/guide/comment-on-validation-reports.html

@@ -6,9 +6,9 @@
 
 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
 
-<meta name="dcterms.date" content="2024-02-27">
+<meta name="dcterms.date" content="2024-03-08">
 
-<title>ValidMind - Link evidence</title>
+<title>ValidMind - Comment on validation reports</title>
 <style>
 code{white-space: pre-wrap;}
 span.smallcaps{font-variant: small-caps;}
@@ -200,14 +200,14 @@ <h2 id="toc-title">On this page</h2>
   <li><a href="#troubleshooting" id="toc-troubleshooting" class="nav-link" data-scroll-target="#troubleshooting">Troubleshooting</a></li>
   <li><a href="#whats-next" id="toc-whats-next" class="nav-link" data-scroll-target="#whats-next">What’s next</a></li>
   </ul>
-<div class="toc-actions"><div><i class="bi bi-github"></i></div><div class="action-links"><p><a href="https://github.com/validmind/documentation/edit/main/site/guide/link-to-evidence.qmd" class="toc-action">Edit this page</a></p><p><a href="https://github.com/validmind/documentation/issues/new" class="toc-action">Report an issue</a></p></div></div></nav>
+<div class="toc-actions"><div><i class="bi bi-github"></i></div><div class="action-links"><p><a href="https://github.com/validmind/documentation/edit/main/site/guide/comment-on-validation-reports.qmd" class="toc-action">Edit this page</a></p><p><a href="https://github.com/validmind/documentation/issues/new" class="toc-action">Report an issue</a></p></div></div></nav>
     </div>
 <!-- main -->
 <main class="content" id="quarto-document-content">
 
 <header id="title-block-header" class="quarto-title-block default">
 <div class="quarto-title">
-<h1 class="title">Link evidence</h1>
+<h1 class="title">Comment on validation reports</h1>
 </div>
 
 
@@ -218,7 +218,7 @@ <h1 class="title">Link evidence</h1>
     <div>
     <div class="quarto-title-meta-heading">Published</div>
     <div class="quarto-title-meta-contents">
-      <p class="date">February 27, 2024</p>
+      <p class="date">March 8, 2024</p>
     </div>
   </div>
 
@@ -229,31 +229,17 @@ <h1 class="title">Link evidence</h1>
 </header>
 
 <p>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.</p>
-<p>[Include a brief description of what this task is about, why it’s important, and who it’s intended for.]</p>
+<p>[Include a brief description of what this task is about and why it’s important.]</p>
 <section id="prerequisites" class="level2">
 <h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
-<p>[Include a list of any prerequisites the user needs to complete before starting the task, such as having certain software installed, access to certain resources, or completing previous tasks.]</p>
+<p>[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.]</p>
 </section>
 <section id="steps" class="level2">
 <h2 class="anchored" data-anchor-id="steps">Steps</h2>
 <ol type="1">
-<li>[Step 1]
-<ul>
-<li>[Include any sub-steps or details needed to complete this step]</li>
-</ul></li>
-<li>[Step 2]
-<ul>
-<li>[Include any sub-steps or details needed to complete this step]</li>
-</ul></li>
-<li>[Step 3]
-<ul>
-<li>[Include any sub-steps or details needed to complete this step]</li>
-<li>[If applicable, include screenshots or images to illustrate the step]</li>
-</ul></li>
-<li>[Step 4]
-<ul>
-<li>[Include any sub-steps or details needed to complete this step]</li>
-</ul></li>
+<li><p>In any section of the validation report, select a portion of text that you would like to comment on and click the <strong>Add comment</strong> button that appears. <!--- **Need image** ---></p></li>
+<li><p>Enter your comment and click <strong>Submit</strong>.</p></li>
+<li><p>You can now view the comment by highlighting the corresponding portion of text, or by clicking the <strong>Comments</strong> tab in the <strong>ValidMind Insights</strong> right sidebar.</p></li>
 </ol>
 </section>
 <section id="troubleshooting" class="level2">

site/_site/guide/configure-aws-privatelink.html

@@ -328,14 +328,14 @@
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">View documentation activity</span></a>
+  <a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Collaborate with others</span></a>
   </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/comment-on-documentation.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Comment on document</span></a>
+  <a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">View documentation activity</span></a>
   </div>
 </li>
           <li class="sidebar-item">
@@ -373,8 +373,20 @@
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/collaborate-on-documentation.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Collaborate on documentation</span></a>
+  <a href="../guide/assess-compliance.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Assess compliance</span></a>
+  </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/work-with-content-blocks.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Work with content blocks</span></a>
+  </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Collaborate with others</span></a>
   </div>
 </li>
           <li class="sidebar-item">

site/_site/guide/customize-documentation-templates.html

@@ -329,14 +329,14 @@
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">View documentation activity</span></a>
+  <a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Collaborate with others</span></a>
   </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/comment-on-documentation.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Comment on document</span></a>
+  <a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">View documentation activity</span></a>
   </div>
 </li>
           <li class="sidebar-item">
@@ -374,8 +374,20 @@
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/collaborate-on-documentation.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Collaborate on documentation</span></a>
+  <a href="../guide/assess-compliance.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Assess compliance</span></a>
+  </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/work-with-content-blocks.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Work with content blocks</span></a>
+  </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Collaborate with others</span></a>
   </div>
 </li>
           <li class="sidebar-item">

site/_site/guide/data-privacy-policy.html

@@ -238,14 +238,14 @@
 </li>
         <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/quickstart-try-developer-framework-with-docker.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Try it with Docker Desktop</span></a>
+  <a href="../guide/quickstart-try-developer-framework-with-colab.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Try it with Google Colaboratory</span></a>
   </div>
 </li>
         <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/quickstart-try-developer-framework-with-colab.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Try it with Google Colaboratory</span></a>
+  <a href="../guide/quickstart-try-developer-framework-in-your-own-developer-environment.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Try it in your own developer environment</span></a>
   </div>
 </li>
         <li class="px-0"><hr class="sidebar-divider hi "></li>

site/_site/guide/edit-model-inventory-fields.html

@@ -328,14 +328,14 @@
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">View documentation activity</span></a>
+  <a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Collaborate with others</span></a>
   </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/comment-on-documentation.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Comment on document</span></a>
+  <a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">View documentation activity</span></a>
   </div>
 </li>
           <li class="sidebar-item">
@@ -373,8 +373,20 @@
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/collaborate-on-documentation.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Collaborate on documentation</span></a>
+  <a href="../guide/assess-compliance.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Assess compliance</span></a>
+  </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/work-with-content-blocks.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Work with content blocks</span></a>
+  </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Collaborate with others</span></a>
   </div>
 </li>
           <li class="sidebar-item">

site/_site/guide/export-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-03-06">
+<meta name="dcterms.date" content="2024-03-14">
 
 <title>ValidMind - Export documentation</title>
 <style>
@@ -328,14 +328,14 @@
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">View documentation activity</span></a>
+  <a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Collaborate with others</span></a>
   </div>
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/comment-on-documentation.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Comment on document</span></a>
+  <a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">View documentation activity</span></a>
   </div>
 </li>
           <li class="sidebar-item">
@@ -373,8 +373,20 @@
 </li>
           <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/collaborate-on-documentation.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Collaborate on documentation</span></a>
+  <a href="../guide/assess-compliance.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Assess compliance</span></a>
+  </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/work-with-content-blocks.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Work with content blocks</span></a>
+  </div>
+</li>
+          <li class="sidebar-item">
+  <div class="sidebar-item-container"> 
+  <a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Collaborate with others</span></a>
   </div>
 </li>
           <li class="sidebar-item">
@@ -436,7 +448,7 @@ <h1 class="title">Export documentation</h1>
     <div>
     <div class="quarto-title-meta-heading">Published</div>
     <div class="quarto-title-meta-contents">
-      <p class="date">March 6, 2024</p>
+      <p class="date">March 14, 2024</p>
     </div>
   </div>
 
@@ -501,7 +513,7 @@ <h2 class="anchored" data-anchor-id="export-validation-report">Export Validation
 <h2 class="anchored" data-anchor-id="whats-next">What’s next</h2>
 <ul>
 <li><a href="../guide/working-with-model-documentation.html">Working with model documentation</a></li>
-<li><a href="../guide/collaborate-on-documentation.html">Collaborate on documentation</a></li>
+<li><a href="../guide/collaborate-with-others.html">Collaborate on documentation</a></li>
 <li><a href="../guide/submit-for-approval.html">Submit for approval</a></li>
 </ul>
 

site/_site/guide/get-started-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-03-06">
+<meta name="dcterms.date" content="2024-03-14">
 
 <title>ValidMind - Get started with the ValidMind Developer Framework</title>
 <style>
@@ -1475,7 +1475,7 @@ <h1 class="title">Get started with the ValidMind Developer Framework</h1>
     <div>
     <div class="quarto-title-meta-heading">Published</div>
     <div class="quarto-title-meta-contents">
-      <p class="date">March 6, 2024</p>
+      <p class="date">March 14, 2024</p>
     </div>
   </div>
 

site/_site/guide/get-started.html

@@ -279,7 +279,7 @@
         <li class="sidebar-item">
   <div class="sidebar-item-container"> 
   <a href="../guide/quickstart-try-developer-framework-in-your-own-developer-environment.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Try it in our own developer environment</span></a>
+ <span class="menu-text">Try it in your own developer environment</span></a>
   </div>
 </li>
         <li class="px-0"><hr class="sidebar-divider hi "></li>

site/_site/guide/glossary.html

@@ -236,14 +236,14 @@
 </li>
         <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/quickstart-try-developer-framework-with-docker.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Try it with Docker Desktop</span></a>
+  <a href="../guide/quickstart-try-developer-framework-with-colab.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Try it with Google Colaboratory</span></a>
   </div>
 </li>
         <li class="sidebar-item">
   <div class="sidebar-item-container"> 
-  <a href="../guide/quickstart-try-developer-framework-with-colab.html" class="sidebar-item-text sidebar-link">
- <span class="menu-text">Try it with Google Colaboratory</span></a>
+  <a href="../guide/quickstart-try-developer-framework-in-your-own-developer-environment.html" class="sidebar-item-text sidebar-link">
+ <span class="menu-text">Try it in your own developer environment</span></a>
   </div>
 </li>
         <li class="px-0"><hr class="sidebar-divider hi "></li>