Skip to content

Quickstart docs site improvements #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 7, 2024
Merged

Quickstart docs site improvements #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
329b9b5
Tweaks to QuickStart experience
nrichers May 3, 2024
97ffd23
Move QuickStart button
nrichers May 3, 2024
a2a21f9
Clarify QuickStart intro
nrichers May 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions site/_site/about/data-privacy-policy.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-04-29">
<meta name="dcterms.date" content="2024-05-02">
<meta name="keywords" content="data privacy, ai risk, model risk management, ValidMind">

<title>ValidMind - Data privacy policy</title>
Expand Down Expand Up @@ -344,7 +344,7 @@
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item">
<span class="menu-text">FINEPRINT</span>
<span class="menu-text">FINE PRINT</span>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -392,7 +392,7 @@ <h1 class="title">Data privacy policy</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">April 29, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down
6 changes: 3 additions & 3 deletions site/_site/about/glossary.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-04-29">
<meta name="dcterms.date" content="2024-05-02">

<title>ValidMind - ValidMind glossary</title>
<style>
Expand Down Expand Up @@ -343,7 +343,7 @@
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item">
<span class="menu-text">FINEPRINT</span>
<span class="menu-text">FINE PRINT</span>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -389,7 +389,7 @@ <h1 class="title">ValidMind glossary</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">April 29, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down
6 changes: 3 additions & 3 deletions site/_site/about/license-agreement.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-04-30">
<meta name="dcterms.date" content="2024-05-02">

<title>ValidMind - SOFTWARE LICENSE AGREEMENT</title>
<style>
Expand Down Expand Up @@ -343,7 +343,7 @@
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item">
<span class="menu-text">FINEPRINT</span>
<span class="menu-text">FINE PRINT</span>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -381,7 +381,7 @@ <h1 class="title">SOFTWARE LICENSE AGREEMENT</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">April 30, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down
6 changes: 3 additions & 3 deletions site/_site/about/overview-model-documentation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-04-30">
<meta name="dcterms.date" content="2024-05-02">

<title>ValidMind - Automated model testing &amp; documentation</title>
<style>
Expand Down Expand Up @@ -377,7 +377,7 @@
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item">
<span class="menu-text">FINEPRINT</span>
<span class="menu-text">FINE PRINT</span>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -426,7 +426,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">April 30, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down
6 changes: 3 additions & 3 deletions site/_site/about/overview-model-risk-management.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-04-30">
<meta name="dcterms.date" content="2024-05-02">

<title>ValidMind - Model risk management &amp; governance</title>
<style>
Expand Down Expand Up @@ -344,7 +344,7 @@
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item">
<span class="menu-text">FINEPRINT</span>
<span class="menu-text">FINE PRINT</span>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -394,7 +394,7 @@ <h1 class="title">Model risk management &amp; governance</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">April 30, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down
6 changes: 3 additions & 3 deletions site/_site/about/overview.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-04-30">
<meta name="dcterms.date" content="2024-05-02">

<title>ValidMind - About ValidMind</title>
<style>
Expand Down Expand Up @@ -342,7 +342,7 @@
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item">
<span class="menu-text">FINEPRINT</span>
<span class="menu-text">FINE PRINT</span>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -386,7 +386,7 @@ <h1 class="title">About ValidMind</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">April 30, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down
6 changes: 3 additions & 3 deletions site/_site/about/style-guide.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-04-30">
<meta name="dcterms.date" content="2024-05-02">

<title>ValidMind - ValidMind style guide</title>
<style>
Expand Down Expand Up @@ -379,7 +379,7 @@
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item">
<span class="menu-text">FINEPRINT</span>
<span class="menu-text">FINE PRINT</span>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -464,7 +464,7 @@ <h1 class="title">ValidMind style guide</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">April 30, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down
6 changes: 3 additions & 3 deletions site/_site/about/validmind-community.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-04-30">
<meta name="dcterms.date" content="2024-05-02">

<title>ValidMind - The ValidMind community</title>
<style>
Expand Down Expand Up @@ -343,7 +343,7 @@
</li>
<li class="px-0"><hr class="sidebar-divider hi "></li>
<li class="sidebar-item">
<span class="menu-text">FINEPRINT</span>
<span class="menu-text">FINE PRINT</span>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -391,7 +391,7 @@ <h1 class="title">The ValidMind community</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">April 30, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down
4 changes: 2 additions & 2 deletions site/_site/guide/faq-data-handling.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-04-30">
<meta name="dcterms.date" content="2024-05-02">
<meta name="keywords" content="faq, data handling and privacy, ai risk, model risk management, ValidMind">

<title>ValidMind - Data handling</title>
Expand Down Expand Up @@ -225,7 +225,7 @@ <h1 class="title">Data handling</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">April 30, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down
4 changes: 2 additions & 2 deletions site/_site/guide/generate-model-documentation.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-04-30">
<meta name="dcterms.date" content="2024-05-02">

<title>ValidMind - Generate model documentation</title>
<style>
Expand Down Expand Up @@ -1552,7 +1552,7 @@ <h1 class="title">Generate model documentation</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">April 30, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down
18 changes: 9 additions & 9 deletions site/_site/guide/get-started-developer-framework.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-05-01">
<meta name="dcterms.date" content="2024-05-02">

<title>ValidMind - Get started with the ValidMind Developer Framework</title>
<style>
Expand Down Expand Up @@ -1633,7 +1633,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">May 1, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down Expand Up @@ -1700,7 +1700,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="1714462548345" data-listing-reading-time-sort="10">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1714675068756" data-listing-reading-time-sort="10">
<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">
Expand All @@ -1714,7 +1714,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="1714581751727" data-listing-reading-time-sort="27">
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1714675068756" data-listing-reading-time-sort="27">
<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">
Expand All @@ -1739,7 +1739,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="1714581751727" data-listing-reading-time-sort="10">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1714675068748" data-listing-reading-time-sort="10">
<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">
Expand All @@ -1753,7 +1753,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="1714462548331" data-listing-reading-time-sort="14">
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1714675068742" data-listing-reading-time-sort="14">
<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">
Expand All @@ -1779,7 +1779,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="1714462548333" data-listing-reading-time-sort="16">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1714675068744" data-listing-reading-time-sort="16">
<a href="../notebooks/code_samples/customization/customizing_metrics_with_output_templates.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -1793,7 +1793,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="1714581751727" data-listing-reading-time-sort="8">
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1714675068742" data-listing-reading-time-sort="8">
<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">
Expand All @@ -1807,7 +1807,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="1714462548333" data-listing-reading-time-sort="9">
<div class="g-col-1" data-index="2" data-listing-file-modified-sort="1714675068745" data-listing-reading-time-sort="9">
<a href="../notebooks/code_samples/time_series/tutorial_time_series_forecasting.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand Down
4 changes: 2 additions & 2 deletions site/_site/guide/get-started-sandbox.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-05-01">
<meta name="dcterms.date" content="2024-05-02">

<title>ValidMind - Welcome to the ValidMind sandbox!</title>
<style>
Expand Down Expand Up @@ -230,7 +230,7 @@ <h1 class="title">Welcome to the ValidMind sandbox!</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">May 1, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down
4 changes: 2 additions & 2 deletions site/_site/guide/get-started.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

<meta name="dcterms.date" content="2024-04-30">
<meta name="dcterms.date" content="2024-05-02">

<title>ValidMind - Get started</title>
<style>
Expand Down Expand Up @@ -350,7 +350,7 @@ <h1 class="title">Get started</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">April 30, 2024</p>
<p class="date">May 2, 2024</p>
</div>
</div>

Expand Down
Loading
Loading