Skip to content

Commit b9ab6d3

Browse files
nrichersnrichers
authored
Update validation report user guide & tweak model doucmentation landing page — IN PROGRESS, DO NOT REVIEW (#158)
* Add listing pages, placeholder topics * WIP Content rework * WIP Content edits * WIP Content rework * WIP Content rework * Add compliance content * Update rendered site * Minor wording tweak
1 parent 926ac3d commit b9ab6d3

File tree

89 files changed

+2386
-3289
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+2386
-3289
lines changed

‎site/_quarto.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ website:
3838
- text: "---"
3939
- text: "{{< fa code >}} CODE SAMPLES"
4040
- text: "{{< fa book >}} QuickStart · `Customer Churn` · `Binary Classification`"
41-
file: ./notebooks/quickstart_customer_churn_full_suite.ipynb
41+
file: notebooks/quickstart_customer_churn_full_suite.ipynb
4242
- text: "{{< fa book-open-reader >}} More Code Samples · `LLM` · `NLP` · `Time Series` · `Etc.`"
4343
file: guide/samples-jupyter-notebooks.qmd
4444
- text: "{{< fa download >}} Download Code Samples · `notebooks.zip`"
@@ -150,8 +150,8 @@ website:
150150
contents:
151151
- guide/view-documentation-guidelines.qmd
152152
- guide/work-with-content-blocks.qmd
153+
- guide/collaborate-with-others.qmd
153154
- guide/view-documentation-activity.qmd
154-
- guide/comment-on-documentation.qmd
155155
- guide/submit-for-approval.qmd
156156
- guide/export-documentation.qmd
157157
- text: "---"
@@ -161,8 +161,9 @@ website:
161161
- file: guide/preparing-validation-reports.qmd
162162
contents:
163163
- guide/view-validation-guidelines.qmd
164-
- guide/collaborate-on-documentation.qmd
165-
# - guide/link-to-evidence.qmd
164+
- guide/assess-compliance.qmd
165+
- guide/work-with-content-blocks.qmd
166+
- guide/collaborate-with-others.qmd
166167
- guide/submit-for-approval.qmd
167168
- guide/work-with-model-findings.qmd
168169
- guide/view-reports.qmd

‎site/_site/guide/assess-compliance-summary.png

61.5 KB
Loading

‎site/_site/guide/collaborate-on-documentation.html renamed to ‎site/_site/guide/assess-compliance.html

Lines changed: 84 additions & 79 deletions
Large diffs are not rendered by default.

‎site/_site/guide/assess-compliance.png

225 KB
Loading

‎site/_site/guide/comment-on-documentation.html renamed to ‎site/_site/guide/collaborate-with-others.html

Lines changed: 109 additions & 32 deletions
Large diffs are not rendered by default.

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

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

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

9-
<meta name="dcterms.date" content="2024-02-27">
9+
<meta name="dcterms.date" content="2024-03-08">
1010

11-
<title>ValidMind - Link evidence</title>
11+
<title>ValidMind - Comment on validation reports</title>
1212
<style>
1313
code{white-space: pre-wrap;}
1414
span.smallcaps{font-variant: small-caps;}
@@ -200,14 +200,14 @@ <h2 id="toc-title">On this page</h2>
200200
<li><a href="#troubleshooting" id="toc-troubleshooting" class="nav-link" data-scroll-target="#troubleshooting">Troubleshooting</a></li>
201201
<li><a href="#whats-next" id="toc-whats-next" class="nav-link" data-scroll-target="#whats-next">What’s next</a></li>
202202
</ul>
203-
<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>
203+
<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>
204204
</div>
205205
<!-- main -->
206206
<main class="content" id="quarto-document-content">
207207

208208
<header id="title-block-header" class="quarto-title-block default">
209209
<div class="quarto-title">
210-
<h1 class="title">Link evidence</h1>
210+
<h1 class="title">Comment on validation reports</h1>
211211
</div>
212212

213213

@@ -218,7 +218,7 @@ <h1 class="title">Link evidence</h1>
218218
<div>
219219
<div class="quarto-title-meta-heading">Published</div>
220220
<div class="quarto-title-meta-contents">
221-
<p class="date">February 27, 2024</p>
221+
<p class="date">March 8, 2024</p>
222222
</div>
223223
</div>
224224

@@ -229,31 +229,17 @@ <h1 class="title">Link evidence</h1>
229229
</header>
230230

231231
<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>
232-
<p>[Include a brief description of what this task is about, why it’s important, and who it’s intended for.]</p>
232+
<p>[Include a brief description of what this task is about and why it’s important.]</p>
233233
<section id="prerequisites" class="level2">
234234
<h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
235-
<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>
235+
<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>
236236
</section>
237237
<section id="steps" class="level2">
238238
<h2 class="anchored" data-anchor-id="steps">Steps</h2>
239239
<ol type="1">
240-
<li>[Step 1]
241-
<ul>
242-
<li>[Include any sub-steps or details needed to complete this step]</li>
243-
</ul></li>
244-
<li>[Step 2]
245-
<ul>
246-
<li>[Include any sub-steps or details needed to complete this step]</li>
247-
</ul></li>
248-
<li>[Step 3]
249-
<ul>
250-
<li>[Include any sub-steps or details needed to complete this step]</li>
251-
<li>[If applicable, include screenshots or images to illustrate the step]</li>
252-
</ul></li>
253-
<li>[Step 4]
254-
<ul>
255-
<li>[Include any sub-steps or details needed to complete this step]</li>
256-
</ul></li>
240+
<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>
241+
<li><p>Enter your comment and click <strong>Submit</strong>.</p></li>
242+
<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>
257243
</ol>
258244
</section>
259245
<section id="troubleshooting" class="level2">

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

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -328,14 +328,14 @@
328328
</li>
329329
<li class="sidebar-item">
330330
<div class="sidebar-item-container">
331-
<a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
332-
<span class="menu-text">View documentation activity</span></a>
331+
<a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
332+
<span class="menu-text">Collaborate with others</span></a>
333333
</div>
334334
</li>
335335
<li class="sidebar-item">
336336
<div class="sidebar-item-container">
337-
<a href="../guide/comment-on-documentation.html" class="sidebar-item-text sidebar-link">
338-
<span class="menu-text">Comment on document</span></a>
337+
<a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
338+
<span class="menu-text">View documentation activity</span></a>
339339
</div>
340340
</li>
341341
<li class="sidebar-item">
@@ -373,8 +373,20 @@
373373
</li>
374374
<li class="sidebar-item">
375375
<div class="sidebar-item-container">
376-
<a href="../guide/collaborate-on-documentation.html" class="sidebar-item-text sidebar-link">
377-
<span class="menu-text">Collaborate on documentation</span></a>
376+
<a href="../guide/assess-compliance.html" class="sidebar-item-text sidebar-link">
377+
<span class="menu-text">Assess compliance</span></a>
378+
</div>
379+
</li>
380+
<li class="sidebar-item">
381+
<div class="sidebar-item-container">
382+
<a href="../guide/work-with-content-blocks.html" class="sidebar-item-text sidebar-link">
383+
<span class="menu-text">Work with content blocks</span></a>
384+
</div>
385+
</li>
386+
<li class="sidebar-item">
387+
<div class="sidebar-item-container">
388+
<a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
389+
<span class="menu-text">Collaborate with others</span></a>
378390
</div>
379391
</li>
380392
<li class="sidebar-item">

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

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -329,14 +329,14 @@
329329
</li>
330330
<li class="sidebar-item">
331331
<div class="sidebar-item-container">
332-
<a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
333-
<span class="menu-text">View documentation activity</span></a>
332+
<a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
333+
<span class="menu-text">Collaborate with others</span></a>
334334
</div>
335335
</li>
336336
<li class="sidebar-item">
337337
<div class="sidebar-item-container">
338-
<a href="../guide/comment-on-documentation.html" class="sidebar-item-text sidebar-link">
339-
<span class="menu-text">Comment on document</span></a>
338+
<a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
339+
<span class="menu-text">View documentation activity</span></a>
340340
</div>
341341
</li>
342342
<li class="sidebar-item">
@@ -374,8 +374,20 @@
374374
</li>
375375
<li class="sidebar-item">
376376
<div class="sidebar-item-container">
377-
<a href="../guide/collaborate-on-documentation.html" class="sidebar-item-text sidebar-link">
378-
<span class="menu-text">Collaborate on documentation</span></a>
377+
<a href="../guide/assess-compliance.html" class="sidebar-item-text sidebar-link">
378+
<span class="menu-text">Assess compliance</span></a>
379+
</div>
380+
</li>
381+
<li class="sidebar-item">
382+
<div class="sidebar-item-container">
383+
<a href="../guide/work-with-content-blocks.html" class="sidebar-item-text sidebar-link">
384+
<span class="menu-text">Work with content blocks</span></a>
385+
</div>
386+
</li>
387+
<li class="sidebar-item">
388+
<div class="sidebar-item-container">
389+
<a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
390+
<span class="menu-text">Collaborate with others</span></a>
379391
</div>
380392
</li>
381393
<li class="sidebar-item">

‎site/_site/guide/dashboard-jupyterlab.png

-330 KB
Binary file not shown.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -238,14 +238,14 @@
238238
</li>
239239
<li class="sidebar-item">
240240
<div class="sidebar-item-container">
241-
<a href="../guide/quickstart-try-developer-framework-with-docker.html" class="sidebar-item-text sidebar-link">
242-
<span class="menu-text">Try it with Docker Desktop</span></a>
241+
<a href="../guide/quickstart-try-developer-framework-with-colab.html" class="sidebar-item-text sidebar-link">
242+
<span class="menu-text">Try it with Google Colaboratory</span></a>
243243
</div>
244244
</li>
245245
<li class="sidebar-item">
246246
<div class="sidebar-item-container">
247-
<a href="../guide/quickstart-try-developer-framework-with-colab.html" class="sidebar-item-text sidebar-link">
248-
<span class="menu-text">Try it with Google Colaboratory</span></a>
247+
<a href="../guide/quickstart-try-developer-framework-in-your-own-developer-environment.html" class="sidebar-item-text sidebar-link">
248+
<span class="menu-text">Try it in your own developer environment</span></a>
249249
</div>
250250
</li>
251251
<li class="px-0"><hr class="sidebar-divider hi "></li>

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

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -328,14 +328,14 @@
328328
</li>
329329
<li class="sidebar-item">
330330
<div class="sidebar-item-container">
331-
<a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
332-
<span class="menu-text">View documentation activity</span></a>
331+
<a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
332+
<span class="menu-text">Collaborate with others</span></a>
333333
</div>
334334
</li>
335335
<li class="sidebar-item">
336336
<div class="sidebar-item-container">
337-
<a href="../guide/comment-on-documentation.html" class="sidebar-item-text sidebar-link">
338-
<span class="menu-text">Comment on document</span></a>
337+
<a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
338+
<span class="menu-text">View documentation activity</span></a>
339339
</div>
340340
</li>
341341
<li class="sidebar-item">
@@ -373,8 +373,20 @@
373373
</li>
374374
<li class="sidebar-item">
375375
<div class="sidebar-item-container">
376-
<a href="../guide/collaborate-on-documentation.html" class="sidebar-item-text sidebar-link">
377-
<span class="menu-text">Collaborate on documentation</span></a>
376+
<a href="../guide/assess-compliance.html" class="sidebar-item-text sidebar-link">
377+
<span class="menu-text">Assess compliance</span></a>
378+
</div>
379+
</li>
380+
<li class="sidebar-item">
381+
<div class="sidebar-item-container">
382+
<a href="../guide/work-with-content-blocks.html" class="sidebar-item-text sidebar-link">
383+
<span class="menu-text">Work with content blocks</span></a>
384+
</div>
385+
</li>
386+
<li class="sidebar-item">
387+
<div class="sidebar-item-container">
388+
<a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
389+
<span class="menu-text">Collaborate with others</span></a>
378390
</div>
379391
</li>
380392
<li class="sidebar-item">

‎site/_site/guide/export-documentation.html

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

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

9-
<meta name="dcterms.date" content="2024-03-06">
9+
<meta name="dcterms.date" content="2024-03-14">
1010

1111
<title>ValidMind - Export documentation</title>
1212
<style>
@@ -328,14 +328,14 @@
328328
</li>
329329
<li class="sidebar-item">
330330
<div class="sidebar-item-container">
331-
<a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
332-
<span class="menu-text">View documentation activity</span></a>
331+
<a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
332+
<span class="menu-text">Collaborate with others</span></a>
333333
</div>
334334
</li>
335335
<li class="sidebar-item">
336336
<div class="sidebar-item-container">
337-
<a href="../guide/comment-on-documentation.html" class="sidebar-item-text sidebar-link">
338-
<span class="menu-text">Comment on document</span></a>
337+
<a href="../guide/view-documentation-activity.html" class="sidebar-item-text sidebar-link">
338+
<span class="menu-text">View documentation activity</span></a>
339339
</div>
340340
</li>
341341
<li class="sidebar-item">
@@ -373,8 +373,20 @@
373373
</li>
374374
<li class="sidebar-item">
375375
<div class="sidebar-item-container">
376-
<a href="../guide/collaborate-on-documentation.html" class="sidebar-item-text sidebar-link">
377-
<span class="menu-text">Collaborate on documentation</span></a>
376+
<a href="../guide/assess-compliance.html" class="sidebar-item-text sidebar-link">
377+
<span class="menu-text">Assess compliance</span></a>
378+
</div>
379+
</li>
380+
<li class="sidebar-item">
381+
<div class="sidebar-item-container">
382+
<a href="../guide/work-with-content-blocks.html" class="sidebar-item-text sidebar-link">
383+
<span class="menu-text">Work with content blocks</span></a>
384+
</div>
385+
</li>
386+
<li class="sidebar-item">
387+
<div class="sidebar-item-container">
388+
<a href="../guide/collaborate-with-others.html" class="sidebar-item-text sidebar-link">
389+
<span class="menu-text">Collaborate with others</span></a>
378390
</div>
379391
</li>
380392
<li class="sidebar-item">
@@ -436,7 +448,7 @@ <h1 class="title">Export documentation</h1>
436448
<div>
437449
<div class="quarto-title-meta-heading">Published</div>
438450
<div class="quarto-title-meta-contents">
439-
<p class="date">March 6, 2024</p>
451+
<p class="date">March 14, 2024</p>
440452
</div>
441453
</div>
442454

@@ -501,7 +513,7 @@ <h2 class="anchored" data-anchor-id="export-validation-report">Export Validation
501513
<h2 class="anchored" data-anchor-id="whats-next">What’s next</h2>
502514
<ul>
503515
<li><a href="../guide/working-with-model-documentation.html">Working with model documentation</a></li>
504-
<li><a href="../guide/collaborate-on-documentation.html">Collaborate on documentation</a></li>
516+
<li><a href="../guide/collaborate-with-others.html">Collaborate on documentation</a></li>
505517
<li><a href="../guide/submit-for-approval.html">Submit for approval</a></li>
506518
</ul>
507519

‎site/_site/guide/get-started-developer-framework.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

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

9-
<meta name="dcterms.date" content="2024-03-06">
9+
<meta name="dcterms.date" content="2024-03-14">
1010

1111
<title>ValidMind - Get started with the ValidMind Developer Framework</title>
1212
<style>
@@ -1475,7 +1475,7 @@ <h1 class="title">Get started with the ValidMind Developer Framework</h1>
14751475
<div>
14761476
<div class="quarto-title-meta-heading">Published</div>
14771477
<div class="quarto-title-meta-contents">
1478-
<p class="date">March 6, 2024</p>
1478+
<p class="date">March 14, 2024</p>
14791479
</div>
14801480
</div>
14811481

‎site/_site/guide/get-started.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@
279279
<li class="sidebar-item">
280280
<div class="sidebar-item-container">
281281
<a href="../guide/quickstart-try-developer-framework-in-your-own-developer-environment.html" class="sidebar-item-text sidebar-link">
282-
<span class="menu-text">Try it in our own developer environment</span></a>
282+
<span class="menu-text">Try it in your own developer environment</span></a>
283283
</div>
284284
</li>
285285
<li class="px-0"><hr class="sidebar-divider hi "></li>

‎site/_site/guide/glossary.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -236,14 +236,14 @@
236236
</li>
237237
<li class="sidebar-item">
238238
<div class="sidebar-item-container">
239-
<a href="../guide/quickstart-try-developer-framework-with-docker.html" class="sidebar-item-text sidebar-link">
240-
<span class="menu-text">Try it with Docker Desktop</span></a>
239+
<a href="../guide/quickstart-try-developer-framework-with-colab.html" class="sidebar-item-text sidebar-link">
240+
<span class="menu-text">Try it with Google Colaboratory</span></a>
241241
</div>
242242
</li>
243243
<li class="sidebar-item">
244244
<div class="sidebar-item-container">
245-
<a href="../guide/quickstart-try-developer-framework-with-colab.html" class="sidebar-item-text sidebar-link">
246-
<span class="menu-text">Try it with Google Colaboratory</span></a>
245+
<a href="../guide/quickstart-try-developer-framework-in-your-own-developer-environment.html" class="sidebar-item-text sidebar-link">
246+
<span class="menu-text">Try it in your own developer environment</span></a>
247247
</div>
248248
</li>
249249
<li class="px-0"><hr class="sidebar-divider hi "></li>

0 commit comments

Comments
 (0)