Skip to content

Commit 0318f5a

Browse files
nrichersnrichers
authored
Better test descriptions (#144)
* Demo test descriptions * Update Makefile, render site * Switch to tabbed view, change collapse-level
1 parent f779bfc commit 0318f5a

File tree

398 files changed

+300643
-1959
lines changed

Some content is hidden

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

398 files changed

+300643
-1959
lines changed

‎site/Makefile

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
SRC_DIR := _source/developer-framework
33
DEST_DIR_NB := notebooks
44
DEST_DIR_PYTHON := _site/validmind
5+
DEST_DIR_TESTS := tests
56

67
# Define .PHONY target for help section
78
.PHONY: help clean clone notebooks python-docs docs-site deploy-demo deploy-prod release-notes
@@ -55,11 +56,17 @@ python-docs:
5556
mkdir -p $(DEST_DIR_PYTHON)
5657
cp -r $(SRC_DIR)/docs/_build/. $(DEST_DIR_PYTHON)
5758

59+
test-descriptions:
60+
@echo "\nUpdating test descriptions source ..."
61+
rm -rf $(DEST_DIR_TESTS)
62+
mkdir -p $(DEST_DIR_TESTS)
63+
cp -r $(SRC_DIR)/build/_test_descriptions/validmind/tests/. $(DEST_DIR_TESTS)
64+
5865
# Get all source files
59-
get-source: clean clone notebooks python-docs
66+
get-source: clean clone notebooks python-docs test-descriptions
6067

6168
# Get all source files
62-
docs-site: clean clone notebooks python-docs
69+
docs-site: clean clone notebooks python-docs test-descriptions
6370
quarto render
6471

6572
# Deployment to https://docs-demo.vm.validmind.ai/

‎site/_quarto.yml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ website:
4646
- text: "{{< fa vial >}} TESTING"
4747
- text: "{{< fa flask-vial >}} Run Tests & Test Suites"
4848
file: guide/testing-overview.qmd
49+
- text: "{{< fa microscope >}} Test Descriptions"
50+
file: guide/test-descriptions.qmd
4951
- text: "---"
5052
- text: "{{< fa book >}} REFERENCE"
5153
- text: "{{< fa external-link >}} Developer Framework"
@@ -64,7 +66,7 @@ website:
6466
- title: "Home"
6567
style: docked
6668
collapse: true
67-
collapse-level: 3
69+
collapse-level: 2
6870
collapse-below: sm
6971

7072
contents:
@@ -102,6 +104,8 @@ website:
102104
file: guide/license-agreement.qmd
103105
- text: "Releases"
104106
contents:
107+
- text: "Join our closed beta!"
108+
file: guide/join-closed-beta.qmd
105109
- text: "October 25, 2023"
106110
file: releases/2023-oct-25/highlights.qmd
107111
contents:
@@ -111,8 +115,6 @@ website:
111115
file: releases/2023-oct-25/bug.qmd
112116
- text: "Documentation updates"
113117
file: releases/2023-oct-25/documentation.qmd
114-
- text: "Join our closed beta!"
115-
file: guide/join-closed-beta.qmd
116118
- text: "September 27, 2023"
117119
file: releases/2023-sep-27/highlights.qmd
118120
contents:
@@ -188,9 +190,12 @@ website:
188190
- text: "---"
189191
# - guide/dataset-object.qmd
190192
# - guide/model-object.qmd
191-
- text: "Tests & test suites"
193+
- text: "Run tests & test suites"
192194
file: guide/testing-overview.qmd
193195
contents: "notebooks/how_to/*.ipynb"
196+
- text: "Test descriptions"
197+
file: guide/test-descriptions.qmd
198+
contents: tests/**
194199
- text: "---"
195200
- text: "Code samples"
196201
file: guide/samples-jupyter-notebooks.qmd
@@ -248,6 +253,4 @@ format:
248253
css: styles.css
249254
link-external-newwindow: true
250255
link-external-icon: true
251-
toc: true
252-
toc-expand: 2
253256
callout-appearance: simple

‎site/_site/guide/before-you-begin.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@
170170
<!-- sidebar -->
171171
<!-- margin-sidebar -->
172172
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
173-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
173+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
174174
<h2 id="toc-title">On this page</h2>
175175

176176
<ul>

‎site/_site/guide/collaborate-on-documentation-projects.html

Lines changed: 3 additions & 3 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="2023-10-10">
9+
<meta name="dcterms.date" content="2023-11-02">
1010
<meta name="keywords" content="Collaborate on documentation projects, ai risk, model risk management, ValidMind">
1111

1212
<title>ValidMind - Collaborate on documentation projects</title>
@@ -383,7 +383,7 @@
383383
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
384384
<!-- margin-sidebar -->
385385
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
386-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
386+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
387387
<h2 id="toc-title">On this page</h2>
388388

389389
<ul>
@@ -428,7 +428,7 @@ <h1 class="title">Collaborate on documentation projects</h1>
428428
<div>
429429
<div class="quarto-title-meta-heading">Published</div>
430430
<div class="quarto-title-meta-contents">
431-
<p class="date">October 10, 2023</p>
431+
<p class="date">November 2, 2023</p>
432432
</div>
433433
</div>
434434

‎site/_site/guide/comment-on-documentation-projects.html

Lines changed: 3 additions & 3 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="2023-10-10">
9+
<meta name="dcterms.date" content="2023-11-02">
1010
<meta name="keywords" content="comment on documentation projects, ai risk, model risk management, ValidMind">
1111

1212
<title>ValidMind - Comment on document projects</title>
@@ -384,7 +384,7 @@
384384
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
385385
<!-- margin-sidebar -->
386386
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
387-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
387+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
388388
<h2 id="toc-title">On this page</h2>
389389

390390
<ul>
@@ -411,7 +411,7 @@ <h1 class="title">Comment on document projects</h1>
411411
<div>
412412
<div class="quarto-title-meta-heading">Published</div>
413413
<div class="quarto-title-meta-contents">
414-
<p class="date">October 10, 2023</p>
414+
<p class="date">November 2, 2023</p>
415415
</div>
416416
</div>
417417

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@
383383
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
384384
<!-- margin-sidebar -->
385385
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
386-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
386+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
387387
<h2 id="toc-title">On this page</h2>
388388

389389
<ul>

‎site/_site/guide/create-documentation-project.html

Lines changed: 3 additions & 3 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="2023-10-10">
9+
<meta name="dcterms.date" content="2023-11-02">
1010
<meta name="keywords" content="create projects, documentation, model developer, model validator, ai risk, model risk management, ValidMind">
1111

1212
<title>ValidMind - Create documentation projects</title>
@@ -384,7 +384,7 @@
384384
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
385385
<!-- margin-sidebar -->
386386
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
387-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
387+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
388388
<h2 id="toc-title">On this page</h2>
389389

390390
<ul>
@@ -410,7 +410,7 @@ <h1 class="title">Create documentation projects</h1>
410410
<div>
411411
<div class="quarto-title-meta-heading">Published</div>
412412
<div class="quarto-title-meta-contents">
413-
<p class="date">October 10, 2023</p>
413+
<p class="date">November 2, 2023</p>
414414
</div>
415415
</div>
416416

‎site/_site/guide/create-your-first-documentation-project.html

Lines changed: 3 additions & 3 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="2023-10-20">
9+
<meta name="dcterms.date" content="2023-11-02">
1010
<meta name="keywords" content="explore, ai risk, model risk management, ValidMind">
1111

1212
<title>ValidMind - Create Your First Documentation Project</title>
@@ -410,7 +410,7 @@
410410
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
411411
<!-- margin-sidebar -->
412412
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
413-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
413+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
414414
<h2 id="toc-title">On this page</h2>
415415

416416
<ul>
@@ -435,7 +435,7 @@ <h1 class="title">Create Your First Documentation Project</h1>
435435
<div>
436436
<div class="quarto-title-meta-heading">Published</div>
437437
<div class="quarto-title-meta-contents">
438-
<p class="date">October 20, 2023</p>
438+
<p class="date">November 2, 2023</p>
439439
</div>
440440
</div>
441441

‎site/_site/guide/document-models-with-framework.html

Lines changed: 3 additions & 3 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="2023-10-10">
9+
<meta name="dcterms.date" content="2023-11-02">
1010
<meta name="keywords" content="document models, model developer, ai risk, model risk management, ValidMind">
1111

1212
<title>ValidMind - Document models with the Developer Framework</title>
@@ -384,7 +384,7 @@
384384
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
385385
<!-- margin-sidebar -->
386386
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
387-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
387+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
388388
<h2 id="toc-title">On this page</h2>
389389

390390
<ul>
@@ -411,7 +411,7 @@ <h1 class="title">Document models with the Developer Framework</h1>
411411
<div>
412412
<div class="quarto-title-meta-heading">Published</div>
413413
<div class="quarto-title-meta-contents">
414-
<p class="date">October 10, 2023</p>
414+
<p class="date">November 2, 2023</p>
415415
</div>
416416
</div>
417417

‎site/_site/guide/document-models-with-ui.html

Lines changed: 3 additions & 3 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="2023-10-10">
9+
<meta name="dcterms.date" content="2023-11-02">
1010
<meta name="keywords" content="document models, model developer, ai risk, model risk management, ValidMind">
1111

1212
<title>ValidMind - Document models with the ValidMind UI</title>
@@ -384,7 +384,7 @@
384384
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
385385
<!-- margin-sidebar -->
386386
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
387-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
387+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
388388
<h2 id="toc-title">On this page</h2>
389389

390390
<ul>
@@ -410,7 +410,7 @@ <h1 class="title">Document models with the ValidMind UI</h1>
410410
<div>
411411
<div class="quarto-title-meta-heading">Published</div>
412412
<div class="quarto-title-meta-contents">
413-
<p class="date">October 10, 2023</p>
413+
<p class="date">November 2, 2023</p>
414414
</div>
415415
</div>
416416

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

Lines changed: 3 additions & 3 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="2023-10-10">
9+
<meta name="dcterms.date" content="2023-11-02">
1010
<meta name="keywords" content="edit model inventory fields, ai risk, model risk management, ValidMind">
1111

1212
<title>ValidMind - Edit model inventory fields</title>
@@ -384,7 +384,7 @@
384384
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
385385
<!-- margin-sidebar -->
386386
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
387-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
387+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
388388
<h2 id="toc-title">On this page</h2>
389389

390390
<ul>
@@ -410,7 +410,7 @@ <h1 class="title">Edit model inventory fields</h1>
410410
<div>
411411
<div class="quarto-title-meta-heading">Published</div>
412412
<div class="quarto-title-meta-contents">
413-
<p class="date">October 10, 2023</p>
413+
<p class="date">November 2, 2023</p>
414414
</div>
415415
</div>
416416

‎site/_site/guide/edit-templates.html

Lines changed: 3 additions & 3 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="2023-10-10">
9+
<meta name="dcterms.date" content="2023-11-02">
1010
<meta name="keywords" content="editing templates, ai risk, model risk management, ValidMind">
1111

1212
<title>ValidMind - Edit templates</title>
@@ -383,7 +383,7 @@
383383
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
384384
<!-- margin-sidebar -->
385385
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
386-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
386+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
387387
<h2 id="toc-title">On this page</h2>
388388

389389
<ul>
@@ -411,7 +411,7 @@ <h1 class="title">Edit templates</h1>
411411
<div>
412412
<div class="quarto-title-meta-heading">Published</div>
413413
<div class="quarto-title-meta-contents">
414-
<p class="date">October 10, 2023</p>
414+
<p class="date">November 2, 2023</p>
415415
</div>
416416
</div>
417417

‎site/_site/guide/editions-and-features.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@
170170
<!-- sidebar -->
171171
<!-- margin-sidebar -->
172172
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
173-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
173+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
174174
<h2 id="toc-title">On this page</h2>
175175

176176
<ul>

‎site/_site/guide/explore-example-documentation-project.html

Lines changed: 3 additions & 3 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="2023-10-10">
9+
<meta name="dcterms.date" content="2023-11-02">
1010
<meta name="keywords" content="explore, ai risk, model risk management, ValidMind">
1111

1212
<title>ValidMind - Explore an Example Documentation Project</title>
@@ -410,7 +410,7 @@
410410
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
411411
<!-- margin-sidebar -->
412412
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
413-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
413+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
414414
<h2 id="toc-title">On this page</h2>
415415

416416
<ul>
@@ -435,7 +435,7 @@ <h1 class="title">Explore an Example Documentation Project</h1>
435435
<div>
436436
<div class="quarto-title-meta-heading">Published</div>
437437
<div class="quarto-title-meta-contents">
438-
<p class="date">October 10, 2023</p>
438+
<p class="date">November 2, 2023</p>
439439
</div>
440440
</div>
441441

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

Lines changed: 3 additions & 3 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="2023-10-10">
9+
<meta name="dcterms.date" content="2023-11-02">
1010
<meta name="keywords" content="export documentation, export model document, export validation report, ai risk, model risk management, ValidMind">
1111

1212
<title>ValidMind - Export documentation</title>
@@ -384,7 +384,7 @@
384384
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
385385
<!-- margin-sidebar -->
386386
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
387-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
387+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
388388
<h2 id="toc-title">On this page</h2>
389389

390390
<ul>
@@ -411,7 +411,7 @@ <h1 class="title">Export documentation</h1>
411411
<div>
412412
<div class="quarto-title-meta-heading">Published</div>
413413
<div class="quarto-title-meta-contents">
414-
<p class="date">October 10, 2023</p>
414+
<p class="date">November 2, 2023</p>
415415
</div>
416416
</div>
417417

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@
240240
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
241241
<!-- margin-sidebar -->
242242
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
243-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
243+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
244244
<h2 id="toc-title">On this page</h2>
245245

246246
<ul>

‎site/_site/guide/faq-integrations.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@
240240
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
241241
<!-- margin-sidebar -->
242242
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
243-
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="2">
243+
<nav id="TOC" role="doc-toc" class="toc-active" data-toc-expanded="3">
244244
<h2 id="toc-title">On this page</h2>
245245

246246
<ul>

0 commit comments

Comments
 (0)