Skip to content

Fix notebook path #254

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
nrichers merged 5 commits into from
Jul 17, 2024
Merged

Fix notebook path #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
57fee64
Hide generate with AI button info
nrichers May 30, 2024
fecb06f
Update rendered site
nrichers Jun 4, 2024
1a97271
Fix notebook path
nrichers Jul 17, 2024
d9d5eb4
Update site/developer/get-started-developer-framework.qmd
nrichers Jul 17, 2024
65156f0
Merge branch 'nrichers-patch-1' of github.com:validmind/documentation…
nrichers Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions site/_site/404.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,8 +202,8 @@
</div>
</div> <!-- /container-fluid -->
</nav>
<div id="quarto-announcement" data-announcement-id="8696dcde533771080b5da682ef685cba" class="alert alert-primary hidden"><div class="quarto-announcement-content">
<p><a href="/./training/training-overview.html"><strong><i class="fa-solid fa-graduation-cap" aria-label="graduation-cap"></i> ValidMind Academy</strong></a> — Gain hands-on experience and explore what ValidMind has to offer with our training environment.</p>
<div id="quarto-announcement" data-announcement-id="0f1a11ac13955650cb4bf3cb8718c185" class="alert alert-primary hidden"><div class="quarto-announcement-content">
<p><a href="/./training/training-overview.html"><strong><i class="fa-solid fa-graduation-cap" aria-label="graduation-cap"></i> ValidMind Academy</strong></a> — Try our training environment to explore what ValidMind has to offer</p>
</div><i class="bi bi-x-lg quarto-announcement-action"></i></div>
</header>
<!-- content -->
Expand Down
4 changes: 2 additions & 2 deletions site/_site/about/contributing/join-community.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,8 @@
</div>
</div> <!-- /container-fluid -->
</nav>
<div id="quarto-announcement" data-announcement-id="8696dcde533771080b5da682ef685cba" class="alert alert-primary hidden"><div class="quarto-announcement-content">
<p><a href="../../training/training-overview.html"><strong><i class="fa-solid fa-graduation-cap" aria-label="graduation-cap"></i> ValidMind Academy</strong></a> — Gain hands-on experience and explore what ValidMind has to offer with our training environment.</p>
<div id="quarto-announcement" data-announcement-id="0f1a11ac13955650cb4bf3cb8718c185" class="alert alert-primary hidden"><div class="quarto-announcement-content">
<p><a href="../../training/training-overview.html"><strong><i class="fa-solid fa-graduation-cap" aria-label="graduation-cap"></i> ValidMind Academy</strong></a> — Try our training environment to explore what ValidMind has to offer</p>
</div><i class="bi bi-x-lg quarto-announcement-action"></i></div>
</header>
<!-- content -->
Expand Down
45 changes: 22 additions & 23 deletions site/_site/about/contributing/style-guide/conventions.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-07-11">
<meta name="dcterms.date" content="2024-07-17">

<title>Conventions – ValidMind</title>
<style>
Expand Down Expand Up @@ -77,6 +77,7 @@
<script src="../../../site_libs/bootstrap/bootstrap.min.js"></script>
<link href="../../../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="../../../site_libs/bootstrap/bootstrap.min.css" rel="stylesheet" id="quarto-bootstrap" data-mode="light">
<link href="../../../site_libs/quarto-contrib/tachyons-4.12.0/tachyons.min.css" rel="stylesheet">
<link href="../../../site_libs/quarto-contrib/fontawesome6-0.1.0/all.css" rel="stylesheet">
<link href="../../../site_libs/quarto-contrib/fontawesome6-0.1.0/latex-fontsize.css" rel="stylesheet">
<script id="quarto-search-options" type="application/json">{
Expand Down Expand Up @@ -279,8 +280,8 @@
</button>
</div>
</nav>
<div id="quarto-announcement" data-announcement-id="8696dcde533771080b5da682ef685cba" class="alert alert-primary hidden"><div class="quarto-announcement-content">
<p><a href="../../../training/training-overview.html"><strong><i class="fa-solid fa-graduation-cap" aria-label="graduation-cap"></i> ValidMind Academy</strong></a> — Gain hands-on experience and explore what ValidMind has to offer with our training environment.</p>
<div id="quarto-announcement" data-announcement-id="0f1a11ac13955650cb4bf3cb8718c185" class="alert alert-primary hidden"><div class="quarto-announcement-content">
<p><a href="../../../training/training-overview.html"><strong><i class="fa-solid fa-graduation-cap" aria-label="graduation-cap"></i> ValidMind Academy</strong></a> — Try our training environment to explore what ValidMind has to offer</p>
</div><i class="bi bi-x-lg quarto-announcement-action"></i></div>
</header>
<!-- content -->
Expand Down Expand Up @@ -492,10 +493,8 @@ <h2 id="toc-title">On this page</h2>
<li><a href="#emphasis" id="toc-emphasis" class="nav-link" data-scroll-target="#emphasis">Emphasis</a></li>
<li><a href="#content-types" id="toc-content-types" class="nav-link" data-scroll-target="#content-types">Content types</a></li>
</ul></li>
<li><a href="#proper-nouns" id="toc-proper-nouns" class="nav-link" data-scroll-target="#proper-nouns">Proper nouns</a>
<ul class="collapse">
<li><a href="#proper-nouns" id="toc-proper-nouns" class="nav-link" data-scroll-target="#proper-nouns">Proper nouns</a></li>
<li><a href="#product-names" id="toc-product-names" class="nav-link" data-scroll-target="#product-names">Product names</a></li>
</ul></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"><ul><li><a href="https://github.com/validmind/documentation/edit/main/site/about/contributing/style-guide/conventions.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/validmind/documentation/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>
Expand All @@ -516,7 +515,7 @@ <h1 class="title">Conventions</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">July 11, 2024</p>
<p class="date">July 17, 2024</p>
</div>
</div>

Expand Down Expand Up @@ -674,8 +673,8 @@ <h3 class="anchored" data-anchor-id="margin-footnotes">Margin footnotes</h3>
</thead>
<tbody>
<tr class="odd">
<td><img src="margin-footnotes_correct.png" class="img-fluid" alt="A screenshot showing a correct example of supplementary links in margin content."></td>
<td><img src="inline-links_incorrect.png" class="img-fluid" alt="A screenshot showing an incorrect example of supplementary links in inline instructional text."></td>
<td><img src="margin-footnotes_correct.png" class="img-fluid" alt="A screenshot showing a correct example of footnote links automatically placed in the margin"></td>
<td><img src="inline-links_incorrect.png" class="img-fluid" alt="A screenshot showing an incorrect example of supplementary links in inline instructional text"></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -722,8 +721,8 @@ <h3 class="anchored" data-anchor-id="emphasis">Emphasis</h3>
<section id="callouts" class="level4 page-columns page-full">
<h4 class="anchored" data-anchor-id="callouts">Callouts</h4>
<p>We use two types of callouts<a href="#fn5" class="footnote-ref" id="fnref5" role="doc-noteref"><sup>5</sup></a> to call attention to supplementary information or issue warnings:</p>
<div class="no-row-height column-margin column-container"><div id="fn5"><p><sup>5</sup>&nbsp;<strong>Quarto:</strong> <a href="https://quarto.org/docs/authoring/callouts.html">Callout Blocks</a></p></div></div><div class="grid">
<div class="g-col-6">
<div class="no-row-height column-margin column-container"><div id="fn5"><p><sup>5</sup>&nbsp;<strong>Quarto:</strong> <a href="https://quarto.org/docs/authoring/callouts.html">Callout Blocks</a></p></div></div><div class="flex flex-wrap justify-around">
<div class="w-40-ns">
<div class="callout callout-style-simple callout-none no-icon callout-titled" title="`.callout`">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
Expand All @@ -738,7 +737,7 @@ <h4 class="anchored" data-anchor-id="callouts">Callouts</h4>
</div>
</div>
</div>
<div class="g-col-6">
<div class="w-50-ns">
<div class="callout callout-style-simple callout-important callout-titled" title="`.callout-important`">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
Expand Down Expand Up @@ -894,7 +893,7 @@ <h4 class="anchored" data-anchor-id="mathematics">Mathematics</h4>
</section>
</section>
</section>
<section id="proper-nouns" class="level2 page-columns page-full">
<section id="proper-nouns" class="level2">
<h2 class="anchored" data-anchor-id="proper-nouns">Proper nouns</h2>
<p>In the context of model risk management, proper nouns include specific models, laws, or regulations, such as “Basel IV” or “SR 11-7.” These refer to specific frameworks or guidelines and you spell them with initial capital letters or exactly as indicated by official sources.</p>
<ul>
Expand Down Expand Up @@ -928,8 +927,9 @@ <h2 class="anchored" data-anchor-id="proper-nouns">Proper nouns</h2>
</tr>
</tbody>
</table>
<section id="product-names" class="level3 page-columns page-full">
<h3 class="anchored" data-anchor-id="product-names">Product names</h3>
</section>
<section id="product-names" class="level2 page-columns page-full">
<h2 class="anchored" data-anchor-id="product-names">Product names</h2>
<p>Within our documentation (<code>https://docs.validmind.ai/</code>), you are able to reference constants such as the ValidMind Developer Framework and ValidMind Platform UI via variables.<a href="#fn11" class="footnote-ref" id="fnref11" role="doc-noteref"><sup>11</sup></a></p>
<div class="no-row-height column-margin column-container"><div id="fn11"><p><sup>11</sup>&nbsp;<strong>Quarto:</strong> <a href="https://quarto.org/docs/authoring/variables.html#var">Variables</a></p></div></div><ul>
<li>Use the variables shown on the table below instead of writing out the phrases to enable consistency between guides everywhere except for image alt text or Mermaid charts.<a href="#fn12" class="footnote-ref" id="fnref12" role="doc-noteref"><sup>12</sup></a></li>
Expand All @@ -940,8 +940,8 @@ <h3 class="anchored" data-anchor-id="product-names">Product names</h3>
<caption>ValidMind product <strong>variable keys</strong></caption>
<colgroup>
<col style="width: 25%">
<col style="width: 30%">
<col style="width: 45%">
<col style="width: 35%">
<col style="width: 40%">
</colgroup>
<thead>
<tr class="header">
Expand All @@ -953,27 +953,27 @@ <h3 class="anchored" data-anchor-id="product-names">Product names</h3>
<tbody>
<tr class="odd">
<td style="text-align: right;"><p>ValidMind AI risk platform</p></td>
<td><code>{{&lt; var vm_risk &gt;}}</code></td>
<td><code>{{&lt; var risk_platform &gt;}}</code></td>
<td>Risk platform with a developer framework for documenting and testing models, alongside a platform UI hosting cloud-based tools, APIs, databases, and validation engines.</td>
</tr>
<tr class="even">
<td style="text-align: right;"><p>ValidMind Developer Framework</p></td>
<td><code>{{&lt; var vm_framework &gt;}}</code></td>
<td><code>{{&lt; var validmind_developer &gt;}}</code></td>
<td>Open-source suite of of tools that connects to the platform UI.</td>
</tr>
<tr class="odd">
<td style="text-align: right;"><p>ValidMind Platform UI</p></td>
<td><code>{{&lt; var vm_platform &gt;}}</code></td>
<td><code>{{&lt; var validmind_platform &gt;}}</code></td>
<td>Hosted multi-tenant architecture that includes a cloud-based web interface.</td>
</tr>
<tr class="even">
<td style="text-align: right;"><p>developer framework</p></td>
<td><code>{{&lt; var vm_dev &gt;}}</code></td>
<td><code>{{&lt; var developer &gt;}}</code></td>
<td>Short form of ValidMind Developer Framework.</td>
</tr>
<tr class="odd">
<td style="text-align: right;"><p>platform UI</p></td>
<td><code>{{&lt; var vm_ui &gt;}}</code></td>
<td><code>{{&lt; var platform &gt;}}</code></td>
<td>Short form of ValidMind Platform UI.</td>
</tr>
<tr class="even">
Expand All @@ -994,7 +994,6 @@ <h3 class="anchored" data-anchor-id="product-names">Product names</h3>
</div>
</div>
</section>
</section>
<section id="whats-next" class="level2">
<h2 class="anchored" data-anchor-id="whats-next">What’s next</h2>
<ul>
Expand Down
12 changes: 6 additions & 6 deletions site/_site/about/contributing/style-guide/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-07-08">
<meta name="dcterms.date" content="2024-07-17">

<title>ValidMind style guide – ValidMind</title>
<style>
Expand Down Expand Up @@ -277,8 +277,8 @@
</button>
</div>
</nav>
<div id="quarto-announcement" data-announcement-id="8696dcde533771080b5da682ef685cba" class="alert alert-primary hidden"><div class="quarto-announcement-content">
<p><a href="../../../training/training-overview.html"><strong><i class="fa-solid fa-graduation-cap" aria-label="graduation-cap"></i> ValidMind Academy</strong></a> — Gain hands-on experience and explore what ValidMind has to offer with our training environment.</p>
<div id="quarto-announcement" data-announcement-id="0f1a11ac13955650cb4bf3cb8718c185" class="alert alert-primary hidden"><div class="quarto-announcement-content">
<p><a href="../../../training/training-overview.html"><strong><i class="fa-solid fa-graduation-cap" aria-label="graduation-cap"></i> ValidMind Academy</strong></a> — Try our training environment to explore what ValidMind has to offer</p>
</div><i class="bi bi-x-lg quarto-announcement-action"></i></div>
</header>
<!-- content -->
Expand Down Expand Up @@ -503,7 +503,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">July 8, 2024</p>
<p class="date">July 17, 2024</p>
</div>
</div>

Expand All @@ -523,7 +523,7 @@ <h2 class="anchored" data-anchor-id="goals">Goals</h2>
<p>The following guidelines are meant to reflect these above principles, and ensure that all of our communications adhere to our vision:</p>
<div id="listing-style-guide" 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="1720723177000" data-listing-file-modified-sort="1720723177272" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="6" data-listing-word-count-sort="1060">
<div class="g-col-1" data-index="0" data-listing-date-sort="1721258747000" data-listing-file-modified-sort="1721258747981" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="6" data-listing-word-count-sort="1060">
<a href="../../../about/contributing/style-guide/voice-and-tone.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<div class="card-body post-contents">
Expand All @@ -537,7 +537,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-date-sort="1720723177000" data-listing-file-modified-sort="1720723177272" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="10" data-listing-word-count-sort="1831">
<div class="g-col-1" data-index="1" data-listing-date-sort="1721258747000" data-listing-file-modified-sort="1721258747980" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="10" data-listing-word-count-sort="1835">
<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">
Expand Down
10 changes: 5 additions & 5 deletions site/_site/about/contributing/style-guide/voice-and-tone.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-07-11">
<meta name="dcterms.date" content="2024-07-17">

<title>Voice and tone – ValidMind</title>
<style>
Expand Down Expand Up @@ -217,8 +217,8 @@
</button>
</div>
</nav>
<div id="quarto-announcement" data-announcement-id="8696dcde533771080b5da682ef685cba" class="alert alert-primary hidden"><div class="quarto-announcement-content">
<p><a href="../../../training/training-overview.html"><strong><i class="fa-solid fa-graduation-cap" aria-label="graduation-cap"></i> ValidMind Academy</strong></a> — Gain hands-on experience and explore what ValidMind has to offer with our training environment.</p>
<div id="quarto-announcement" data-announcement-id="0f1a11ac13955650cb4bf3cb8718c185" class="alert alert-primary hidden"><div class="quarto-announcement-content">
<p><a href="../../../training/training-overview.html"><strong><i class="fa-solid fa-graduation-cap" aria-label="graduation-cap"></i> ValidMind Academy</strong></a> — Try our training environment to explore what ValidMind has to offer</p>
</div><i class="bi bi-x-lg quarto-announcement-action"></i></div>
</header>
<!-- content -->
Expand Down Expand Up @@ -457,7 +457,7 @@ <h1 class="title">Voice and tone</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">July 11, 2024</p>
<p class="date">July 17, 2024</p>
</div>
</div>

Expand Down Expand Up @@ -617,7 +617,7 @@ <h3 class="anchored" data-anchor-id="make-it-accessible">Make it accessible</h3>
<td>The findings are then submitted to the chairman of the MRMG, who will then review the recommendations and provide his status assessments.</td>
</tr>
<tr class="even">
<td><code>![](link-evidence.png){fig-alt="A screenshot of the validation report section 2.1.1. that shows a compliance assessment with the option to link to evidence."}</code></td>
<td><code>![](link-evidence.png){fig-alt="A screenshot of the validation report section 2.1.1. that shows a compliance assessment with the option to link to evidence"}</code></td>
<td><code>![](link-evidence.png)</code></td>
</tr>
</tbody>
Expand Down
8 changes: 4 additions & 4 deletions site/_site/about/contributing/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-07-08">
<meta name="dcterms.date" content="2024-07-17">

<title>ValidMind community – ValidMind</title>
<style>
Expand Down Expand Up @@ -216,8 +216,8 @@
</button>
</div>
</nav>
<div id="quarto-announcement" data-announcement-id="8696dcde533771080b5da682ef685cba" class="alert alert-primary hidden"><div class="quarto-announcement-content">
<p><a href="../../training/training-overview.html"><strong><i class="fa-solid fa-graduation-cap" aria-label="graduation-cap"></i> ValidMind Academy</strong></a> — Gain hands-on experience and explore what ValidMind has to offer with our training environment.</p>
<div id="quarto-announcement" data-announcement-id="0f1a11ac13955650cb4bf3cb8718c185" class="alert alert-primary hidden"><div class="quarto-announcement-content">
<p><a href="../../training/training-overview.html"><strong><i class="fa-solid fa-graduation-cap" aria-label="graduation-cap"></i> ValidMind Academy</strong></a> — Try our training environment to explore what ValidMind has to offer</p>
</div><i class="bi bi-x-lg quarto-announcement-action"></i></div>
</header>
<!-- content -->
Expand Down Expand Up @@ -442,7 +442,7 @@ <h1 class="title">ValidMind community</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">July 8, 2024</p>
<p class="date">July 17, 2024</p>
</div>
</div>

Expand Down
Loading