Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ These directories may have sub-directories depending on their size and grouped s

#### Supporting `site` directories
- `_site` — This is where static files rendered by `quarto render` get placed.
- `assets` — This is where general shared assets live (stylesheets, promotional images, etc.).
- `assets` — This is where general shared assets live (stylesheets, promotional images, all videos, etc.).
- `internal` — For internal testing only.
- `notebooks` — This is where notebooks retrieved from the [`developer-framework` repo](https://github.com/validmind/developer-framework) live.
- `tests` — This is where test descriptions generated from the Python source in the [developer-framework repo](https://github.com/validmind/developer-framework) live.
Expand Down Expand Up @@ -118,6 +118,13 @@ When constructing filepaths, including while using [Quarto's Includes](https://q

Refer to the [`tachyons-flexbox.qmd`](templates/tachyons-flexbox.qmd) template for an example.

### Asset files
> If there are additional files that Quarto does not copy over automatically, place them into `/assets`. These files might include:

- Videos
- Stylesheets
- Font files

### Jupyter Notebooks
> Notebooks (`.ipynb` files) are NOT edited via this `documentation` repo, as any changes will be overridden.

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Once saved, your new template version becomes available for use with model docum
::: {.column-page-inset-right}

```{=html}
<!DOCTYPE html><html lang=en> <head><script src=https://code.jquery.com/jquery-3.4.1.min.js integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin=anonymous></script><link href=https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css rel=stylesheet integrity=sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T crossorigin=anonymous><script src=https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js integrity=sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM crossorigin=anonymous></script><link rel=stylesheet type=text/css href=schema_doc.css><script src=https://use.fontawesome.com/facf9fa52c.js></script><script src=schema_doc.min.js></script><meta charset=utf-8><title>Schema Docs</title>
<!DOCTYPE html><html lang=en> <head><script src=https://code.jquery.com/jquery-3.4.1.min.js integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin=anonymous></script><link href=https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css rel=stylesheet integrity=sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T crossorigin=anonymous><script src=https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js integrity=sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM crossorigin=anonymous></script><link rel=stylesheet type=text/css href=/assets/css/schema_doc.css><script src=https://use.fontawesome.com/facf9fa52c.js></script><script src=/assets/css/schema_doc.min.js></script><meta charset=utf-8><title>Schema Docs</title>

<!-- NR Start CSS kludge
The Bootstrap CSS from this HTML document hides the top navbar of our docs site and turns link colors in the text blue. This kludge works around this.
Expand Down
2 changes: 2 additions & 0 deletions site/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ pagetitle: "Welcome to our documentation"
page-layout: full
sidebar: false
repo-actions: false
resources:
- assets/**
filters:
- tachyons
---
Expand Down
8 changes: 4 additions & 4 deletions site/releases/2024-mar-27/highlights.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ New metric metadata available in the {{< var validmind_platform >}} makes it eas

Test results metadata is available directly in your model documentation:

<video src="display-result-metadata.mp4" controls alt="A screenshot of the new Model Findings page showing a table of findings that can be clicked on." style="width: 80%; border: 4px solid #333; box-shadow: 5px 5px 5px #ccc, -5px 5px 5px #ccc; border-radius: 5px;">
<video src="/assets/video/releases/display-result-metadata.mp4" controls alt="A screenshot of the new Model Findings page showing a table of findings that can be clicked on." style="width: 80%; border: 4px solid #333; box-shadow: 5px 5px 5px #ccc, -5px 5px 5px #ccc; border-radius: 5px;">
Your browser does not support the video tag.
</video>

Expand Down Expand Up @@ -65,7 +65,7 @@ We enhanced both the **Model Inventory** and **Model Findings** pages to allow f

On the **Model Inventory** page, you can show or hide table columns by clicking the **Manage Columns** button and toggling individual columns on or off:

<video src="model-inventory-manage-columns.mp4" controls alt="A video that demonstrates how you can show or hide table columns on the Model Inventory page by clicking the Manage Columns button and toggling individual columns on or off." style="width: 80%; border: 4px solid #333; box-shadow: 5px 5px 5px #ccc, -5px 5px 5px #ccc; border-radius: 5px;">
<video src="/assets/video/releases/model-inventory-manage-columns.mp4" controls alt="A video that demonstrates how you can show or hide table columns on the Model Inventory page by clicking the Manage Columns button and toggling individual columns on or off." style="width: 80%; border: 4px solid #333; box-shadow: 5px 5px 5px #ccc, -5px 5px 5px #ccc; border-radius: 5px;">
Your browser does not support the video tag.
</video><br>

Expand All @@ -85,7 +85,7 @@ When registering new models in the model inventory, you can now designate custom

You can specify the custom fields that are required under **{{< fa gear >}} Settings** > **Custom Fields**:

<video src="required-custom-fields.mp4" controls alt="A video that demonstrates how you can add custom fields under Settings > Custom Fields." style="width: 80%; border: 4px solid #333; box-shadow: 5px 5px 5px #ccc, -5px 5px 5px #ccc; border-radius: 5px;">
<video src="/assets/video/releases/required-custom-fields.mp4" controls alt="A video that demonstrates how you can add custom fields under Settings > Custom Fields." style="width: 80%; border: 4px solid #333; box-shadow: 5px 5px 5px #ccc, -5px 5px 5px #ccc; border-radius: 5px;">
Your browser does not support the video tag.
</video><br>

Expand All @@ -109,7 +109,7 @@ These improvements enable you to manage collections of users at the organization

You can create new user groups under **{{< fa gear >}} Settings** > **Groups**:

<video src="create-new-group.mp4" controls alt="A video that demonstrates how you can create new user groups under Settings > Groups." style="width: 80%; border: 4px solid #333; box-shadow: 5px 5px 5px #ccc, -5px 5px 5px #ccc; border-radius: 5px;">
<video src="/assets/video/releases/create-new-group.mp4" controls alt="A video that demonstrates how you can create new user groups under Settings > Groups." style="width: 80%; border: 4px solid #333; box-shadow: 5px 5px 5px #ccc, -5px 5px 5px #ccc; border-radius: 5px;">
Your browser does not support the video tag.
</video><br>

Expand Down
2 changes: 1 addition & 1 deletion site/styles.css
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/* Fix ValidMind logo size and alignment */
@font-face {
font-family: 'Inter';
src: url('/fonts/Inter/static/Inter-Regular.ttf') format('truetype');
src: url('assets/fonts/Inter/static/Inter-Regular.ttf') format('truetype');
font-weight: normal;
font-style: normal;
}
Expand Down