Skip to content

Commit f338903

Browse files
LoiAnsahLoiAnsah
authored
Merge 81d42ef into adc36b9 
2 parents adc36b9 + 81d42ef commit f338903

File tree

63 files changed

+4101
-1123
lines changed

Some content is hidden

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

63 files changed

+4101
-1123
lines changed

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ When constructing links, refer to the `.qmd` file as Quarto will properly render
106106

107107
| Correct | Incorrect |
108108
|---|---|
109-
| `[Quickstart — Model Development](get-started/developer/quickstart-developer.qmd)` | `[Quickstart — Model Development](get-started/developer/quickstart-developer.html)` |
109+
| `[Get started with JupyterHub](get-started/developer/try-with-jupyterhub.qmd)` | `[Get started with JupyterHub](get-started/developer/try-with-jupyterhub.html)` |
110110

111111
When constructing filepaths, including while using [Quarto's Includes](https://quarto.org/docs/authoring/includes.html) (single-sourcing feature), you'll also want start with the root directory whenever possible as this minimizes usage of unclear relative paths:
112112

‎site/_quarto.yml

Lines changed: 153 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,14 @@ metadata-files:
1212

1313
website:
1414
announcement:
15-
content: "[**{{< fa book-open-reader >}} EU AI Act Compliance**](https://validmind.com/download-whitepaper-the-eu-ai-act/) — Read our original regulation brief on how the EU AI Act aims to balance innovation with safety and accountability, setting standards for responsible AI use"
16-
position: below-navbar
15+
content: '[**{{< fa book-open-reader >}} EU AI Act Compliance**](https://validmind.com/download-whitepaper-the-eu-ai-act/) — Read our original regulation brief on how the EU AI Act aims to balance innovation with safety and accountability, setting standards for responsible AI use'
16+
position: above-navbar
1717
favicon: validmind.png
1818
title: "ValidMind"
1919
cookie-consent:
2020
type: express
2121
style: simple
22+
position: center
2223
google-analytics:
2324
tracking-id: "G-S46CKWPNSS"
2425
anonymize-ip: true
@@ -35,58 +36,12 @@ website:
3536
title: false
3637
pinned: true
3738

38-
left:
39-
- text: "About"
40-
file: about/overview.qmd
41-
- text: "Get Started"
42-
file: get-started/get-started.qmd
43-
- text: "Guides"
44-
file: guide/guides.qmd
45-
- text: "{{< fa cube >}} {{< var validmind.developer >}}"
46-
menu:
47-
- text: "{{< fa laptop-code >}} {{< var validmind.developer >}}"
48-
file: developer/validmind-library.qmd
49-
- text: "{{< fa cubes >}} Supported Models"
50-
file: developer/supported-models.qmd
51-
- text: "---"
52-
- text: "{{< fa rocket >}} QUICKSTART"
53-
- text: "{{< fa file-pen >}} For Model Documentation"
54-
file: notebooks/quickstart/quickstart_model_documentation.ipynb
55-
- text: "{{< fa clipboard-check >}} For Model Validation"
56-
file: notebooks/quickstart/quickstart_model_validation.ipynb
57-
- text: "---"
58-
- text: "{{< fa vial >}} TESTING"
59-
- text: "{{< fa flask-vial >}} Run Tests & Test Suites"
60-
file: developer/model-testing/testing-overview.qmd
61-
- text: "{{< fa microscope >}} Test Descriptions"
62-
file: developer/model-testing/test-descriptions.qmd
63-
- text: "{{< fa toolbox >}} Test Sandbox (BETA)"
64-
file: developer/model-testing/test-sandbox.qmd
65-
- text: "---"
66-
- text: "{{< fa code >}} CODE SAMPLES"
67-
- text: "{{< fa book-open-reader >}} All Code Samples · `LLM` · `NLP` · `Time Series` · `Etc.`"
68-
file: developer/samples-jupyter-notebooks.qmd
69-
- text: "{{< fa download >}} Download Code Samples · `notebooks.zip`"
70-
file: notebooks.zip
71-
- text: "{{< fa hand-point-right >}} Try it on JupyterHub {{< fa hand-point-left >}}"
72-
file: https://jupyterhub.validmind.ai/
73-
- text: "---"
74-
- text: "{{< fa book >}} REFERENCE"
75-
- text: "{{< var validmind.api >}}"
76-
file: validmind/validmind.qmd
77-
- text: "Support"
78-
file: support/support.qmd
79-
- text: "Training"
80-
file: training/training.qmd
81-
- text: "Releases"
82-
file: releases/all-releases.qmd
83-
# - text: "validmind.com {{< fa external-link >}}"
84-
# file: https://validmind.com/
85-
# target: _blank
8639
right:
40+
# - text: "{{< fa cube >}} Documentation"
41+
# file: about/overview.qmd
8742
# HOME BUTTON FOR DEVELOPER & TRAINING SECTIONS
88-
- text: "{{< fa house >}}"
89-
file: index.qmd
43+
# - text: "{{< fa house >}}"
44+
# file: index.qmd
9045
# DOCUMENTATION MENU FOR DEVELOPER & TRAINING SECTIONS
9146
- text: "{{< fa book-open >}} Documentation"
9247
menu:
@@ -125,6 +80,28 @@ website:
12580
# file: training/developer-fundamentals/developer-fundamentals-register.qmd
12681
# - text: "{{< fa user-check >}} For Validators"
12782
# file: training/validator-fundamentals/validator-fundamentals-register.qmd
83+
84+
- text: "{{< fa book-open >}} Documentation"
85+
menu:
86+
- text: "{{< fa circle-info >}} About {{< var vm.product >}}"
87+
file: about/overview.qmd
88+
- text: "{{< fa rocket >}} Get Started"
89+
file: get-started/get-started.qmd
90+
- text: "{{< fa book >}} Guides"
91+
file: guide/guides.qmd
92+
- text: "{{< fa envelope-open-text >}} Support"
93+
file: support/support.qmd
94+
- text: "{{< fa bullhorn >}} Releases"
95+
file: releases/all-releases.qmd
96+
- text: "---"
97+
- text: "{{< fa cube >}} Python Library"
98+
- text: "{{< fa code >}} {{< var validmind.developer >}}"
99+
file: developer/validmind-library.qmd
100+
- text: "---"
101+
- text: "{{< fa graduation-cap >}} {{< var validmind.training >}}"
102+
- text: "{{< fa building-columns >}} Training Courses"
103+
file: training/training.qmd
104+
128105
- text: "Log In"
129106
menu:
130107
- text: "Public Internet"
@@ -141,6 +118,7 @@ website:
141118
- text: "---"
142119
- text: "<small>Which login should I use?</small>"
143120
href: "guide/configuration/log-in-to-validmind.qmd"
121+
144122

145123
# COMMENT THIS OUT WHEN DONE TESTING
146124
# - text: "{{< fa flask >}} Testing"
@@ -316,52 +294,133 @@ website:
316294
file: faq/faq-privacy.qmd
317295

318296
# COMMENT THIS OUT WHEN DONE TESTING
319-
# - title: "Testing"
320-
# contents:
321-
# - internal/testing.qmd
322-
# - text: "---"
323-
# - text: "EXPERIMENTS"
324-
# - file: internal/lightbox.qmd
325-
# - file: internal/footnotes/footnotes.qmd
326-
# contents:
327-
# - internal/footnotes/hover-only.qmd
297+
- title: "Testing"
298+
contents:
299+
- internal/testing.qmd
300+
- text: "---"
301+
- text: "EXPERIMENTS"
302+
- file: internal/lightbox.qmd
303+
- file: internal/footnotes/footnotes.qmd
304+
contents:
305+
- internal/footnotes/hover-only.qmd
328306

329307
page-footer:
330-
background: "#DE257E"
331-
left: "© Copyright {{< now year >}} {{< var validmind.legal >}} All Rights Reserved."
308+
background: "#26818B"
309+
left:
310+
- text: |
311+
<div class="footer-section footer-logo-info">
312+
<img src="/homepage_docsite/ValidMind%20MASTER%20Brand%20Assets_Logo-White%20R%202.svg" alt="ValidMind Logo" class="footer-logo" />
313+
<div class="footer-logo-columns">
314+
<div class="footer-logo-links">
315+
<ul>
316+
<li><a href="/news">News</a></li>
317+
<li><a href="/careers">Careers</a></li>
318+
<li><a href="/contact">Contact</a></li>
319+
<li><a href="/legal">Legal</a></li>
320+
</ul>
321+
</div>
322+
<div class="footer-logo-divider"></div>
323+
<div class="footer-company-info">
324+
<div>© Copyrigh {{< now year >}}<br>ValidMind Inc.<br>All Rights Reserved.</div>
325+
<a id="open_preferences_center" class="cookie-preferences-link" href="#">Cookie preferences</a>
326+
</div>
327+
</div>
328+
</div>
329+
- text: |
330+
<div class="footer-divider"></div>
331+
- text: |
332+
<div class="footer-section footer-user-guides">
333+
<div class="footer-heading">User Guides</div>
334+
<div class="footer-user-guides-columns">
335+
<ul>
336+
<li><a href="/get-started/get-started.qmd">Get started</a></li>
337+
<li><a href="/guide/model-validation/manage-validation-guidelines.qmd">Onboarding</a></li>
338+
<li><a href="/guide/guides.qmd">Model Inventory</a></li>
339+
<li><a href="/releases/all-releases.qmd">What's new?</a></li>
340+
</ul>
341+
<ul>
342+
<li><a href="/guide/model-documentation/working-with-model-documentation.qmd">Model documentation</a></li>
343+
<li><a href="/guide/model-validation/manage-validation-guidelines.qmd">Model validation</a></li>
344+
<li><a href="/guide/model-workflows/working-with-model-workflows.qmd">Model workflows</a></li>
345+
</ul>
346+
<ul>
347+
<li><a href="/guide/reporting/working-with-analytics.qmd">Reporting</a></li>
348+
<li><a href="/guide/monitoring/ongoing-monitoring.qmd">Monitoring</a></li>
349+
<li><a href="/guide/attestation/working-with-attestations.qmd">Attestation</a></li>
350+
</ul>
351+
</div>
352+
</div>
353+
center:
354+
- text: |
355+
<div class="footer-divider"></div>
356+
- text: |
357+
<div class="footer-section">
358+
<div class="footer-heading">ValidMind Library</div>
359+
<ul>
360+
<li><a href="/developer/validmind-library.qmd">For model development</a></li>
361+
<li><a href="/developer/validmind-library.qmd#validation">For model validation</a></li>
362+
<li><a href="/developer/samples-jupyter-notebooks.qmd">Code samples</a></li>
363+
<li><a href="/validmind/validmind.qmd">API Reference</a></li>
364+
</ul>
365+
</div>
366+
- text: |
367+
<div class="footer-divider"></div>
368+
- text: |
369+
<div class="footer-section">
370+
<div class="footer-heading">Training</div>
371+
<ul>
372+
<li><a href="/training/training.qmd">Learning paths</a></li>
373+
<li><a href="/training/training.qmd">Courses</a></li>
374+
<li><a href="/training/training.qmd">Videos</a></li>
375+
</ul>
376+
</div>
332377
right:
333-
- text: "validmind.com {{< fa external-link >}}"
334-
href: https://validmind.com/
335-
target: _blank
336-
- text: "Privacy Policy"
337-
href: https://validmind.com/about/legal/privacy-policy/
338-
- text: "Terms of Use"
339-
href: https://validmind.com/about/legal/terms-of-use/
340-
- icon: github
341-
href: https://github.com/validmind/documentation
342-
- icon: linkedin
343-
href: https://www.linkedin.com/company/validmind/
344-
378+
- text: |
379+
<div class="footer-divider"></div>
380+
- text: |
381+
<div class="footer-section">
382+
<div class="footer-heading">Support</div>
383+
<ul>
384+
<li><a href="/support/troubleshooting.qmd">Troubleshooting</a></li>
385+
<li><a href="/faq/faq.qmd">FAQ</a></li>
386+
<li><a href="/support/support.qmd">Get help</a></li>
387+
</ul>
388+
</div>
389+
- text: |
390+
<div class="footer-divider"></div>
391+
- text: |
392+
<div class="footer-section">
393+
<div class="footer-heading">Community</div>
394+
<ul>
395+
<li><a href="https://github.com/validmind/documentation">Github</a></li>
396+
<li><a href="#">Slack</a></li>
397+
<li><a href="#">Blog</a></li>
398+
</ul>
399+
</div>
345400
format:
346-
html:
347-
grid:
348-
body-width: 1000px
349-
footnotes-hover: true
350-
reference-location: margin
351-
code-overflow: wrap
352-
code-annotations: below
353-
theme:
354-
light: [cosmo, theme.scss]
401+
html:
402+
grid:
403+
body-width: 1000px
404+
footnotes-hover: true
405+
reference-location: margin
406+
code-overflow: wrap
407+
code-annotations: below
408+
theme:
409+
light: [cosmo, theme.scss]
355410
# dark: [cosmo, theme-dark.scss]
356-
mainfont: Inter
357-
css: styles.css
358-
toc: true
359-
link-external-newwindow: true
360-
link-external-icon: true
361-
callout-appearance: simple
362-
link-external-filter: '^https:\/\/(docs\.validmind\.ai|docs-staging\.validmind\.ai|docs-demo\.vm\.validmind\.ai)\/.*'
363-
lightbox: true
411+
mainfont: Inter
412+
css: styles.css
413+
toc: true
414+
link-external-newwindow: true
415+
link-external-icon: true
416+
callout-appearance: simple
417+
link-external-filter: '^https:\/\/(docs\.validmind\.ai|docs-staging\.validmind\.ai|docs-demo\.vm\.validmind\.ai)\/.*'
418+
lightbox: true
419+
364420

365421
filters:
366-
- tachyons
367-
- preview
422+
- tachyons
423+
- preview
424+
425+
426+

‎site/about/overview-model-documentation.qmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ listing:
99
grid-columns: 2
1010
# image-height: 100%
1111
contents:
12-
- path: ../get-started/get-started.qmd
13-
title: "Get started"
14-
description: "Our quickstarts are the quickest and easiest way to try out our product features."
12+
- path: ../get-started/quickstart.qmd
13+
title: "QuickStart"
14+
description: "Our QuickStart is the quickest and easiest way to try out our product features."
1515
fields: [title, description, reading-time]
1616
---
1717

‎site/about/overview-model-risk-management.qmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ listing:
99
grid-columns: 2
1010
# image-height: 100%
1111
contents:
12-
- path: ../get-started/get-started.qmd
13-
title: "Get started"
14-
description: "Our quickstarts are the quickest and easiest way to try out our product features."
12+
- path: ../get-started/quickstart.qmd
13+
title: "QuickStart"
14+
description: "Our QuickStart is the quickest and easiest way to try out our product features."
1515
fields: [title, description, reading-time]
1616
---
1717

‎site/developer/validmind-library.qmd

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
2-
# USING THE VARIABLE MESSES UP THE SPACING ON THE PREVIEW TILE
3-
title: "ValidMind Library"
2+
title: "{{< var validmind.developer >}}"
43
date: last-modified
54
aliases:
65
- /guide/get-started-developer-framework.html
@@ -85,7 +84,7 @@ listing:
8584
- ../guide/model-documentation/work-with-content-blocks.qmd
8685
---
8786

88-
The {{< var validmind.developer >}} streamlines model development and validation by automating testing. Run tests, log those test results to the {{< var validmind.platform >}}, and have fully supported drafts of documentation or reporting ready for you to fine-tune.
87+
The {{< var validmind.developer >}} helps you streamline model documentation by automating the generation of drafts. All you need to do is upload your documentation artifacts and test results to the {{< var validmind.platform >}}.
8988

9089
## What is the {{< var validmind.developer >}}?
9190

‎site/get-started/_sidebar.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ website:
44
title: "Get Started"
55
contents:
66
- text: "Quickstart For"
7-
- text: "Model Development"
7+
- text: "Model development"
88
file: get-started/developer/quickstart-developer.qmd
9-
- text: "Model Validation"
9+
- text: "Model validation"
1010
file: get-started/validator/quickstart-validator.qmd
11-
- text: "Setup & Administration"
11+
- text: "Setup & administration"
1212
file: get-started/administrator/quickstart-administrator.qmd

‎site/get-started/administrator/quickstart-administrator 2.qmd

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "Quickstart — Setup & Administration [coming soon]{.smallercaps .pink}"
3+
date: last-modified
4+
page-layout: full
5+
---
6+
7+
Set up your organization, onboard new users, and set up user roles, permissions, and groups within the {{< var validmind.platform >}} as a superuser.

‎site/get-started/administrator/quickstart-administrator.qmd

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,4 @@ date: last-modified
44
page-layout: full
55
---
66

7-
Set up the foundational units for your organization within the {{< var validmind.platform >}}, prepare your organization for users, then grant access to your first user.
8-
9-
<!-- BECK'S OUTLINE / NOTES -->
10-
11-
<!-- {{< include /get-started/common-assets/_before-you-begin.qmd >}}
12-
13-
## Setting up your organization
14-
15-
### Set up business units
16-
17-
### Set up use cases
18-
19-
## Preparing your organization for users
20-
21-
### Set up groups
22-
23-
### Set up roles
24-
25-
## Invite your first user
26-
27-
## What's next
28-
29-
- Administrator Fundamentals
30-
- ValidMind Platform Guides -->
7+
Set up your organization, onboard new users, and set up user roles, permissions, and groups within the {{< var validmind.platform >}} as a superuser.

0 commit comments

Comments
 (0)