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
11 changes: 9 additions & 2 deletions .github/workflows/merge-main-into-staging.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,16 @@ jobs:
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"

- name: Merge in main branch
- name: Merge in main branch (prefer main on conflicts)
run: |
git merge --no-ff origin/main
if ! git merge -X theirs --no-edit origin/main; then
echo "::warning::Merge reported conflicts; taking main's version for unresolved paths."
git diff --name-only --diff-filter=U | while IFS= read -r file; do
git checkout --theirs -- "$file"
git add -- "$file"
done
git commit --no-edit
fi

# NEW: detect the PR that triggered this push to main (if any)
- name: Determine source PR (if any)
Expand Down
25 changes: 14 additions & 11 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ metadata-files:
- installation/_sidebar.yaml

website:
# announcement:
# announcement:
# 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'
# position: above-navbar
favicon: favicon.svg
Expand All @@ -29,15 +29,15 @@ website:
type: express
style: simple
position: center
google-analytics:
google-analytics:
tracking-id: "G-S46CKWPNSS"
anonymize-ip: true
show-item-context: true
page-navigation: true
repo-url: https://github.com/validmind/documentation/
repo-subdir: site/
repo-actions: [edit, issue]

navbar:
collapse-below: xl
logo: logo.svg
Expand Down Expand Up @@ -136,18 +136,21 @@ website:
contents:
- text: "Access & permissions"
file: faq/faq-organizations.qmd
- faq/faq-workflows.qmd
- text: "Inventory & activity"
file: faq/faq-inventory.qmd
- text: "Integrations & support"
file: faq/faq-integrations.qmd
- text: "Workflows & lifecycles"
file: faq/faq-workflows.qmd
- faq/faq-inventory.qmd
- text: "Documents & templates"
file: faq/faq-documentation.qmd
- faq/faq-testing.qmd
- text: "Validation & artifacts"
file: faq/faq-validation.qmd
- faq/faq-collaboration.qmd
- text: "Monitoring & reporting"
- text: "Reporting & monitoring"
file: faq/faq-reporting.qmd
- faq/faq-testing.qmd
- faq/faq-integrations.qmd
- text: "Attestations"
file: faq/faq-attestations.qmd
- text: "Data & privacy"
file: faq/faq-privacy.qmd

Expand Down Expand Up @@ -207,7 +210,7 @@ website:
<li><a href="/guide/guides.qmd#documents-templates">Documents & templates</a></li>
<li><a href="/guide/guides.qmd#documentation">Documentation</a></li>
<li><a href="/guide/guides.qmd#validation">Validation</a></li>
<li><a href="/guide/guides.qmd#reporting">Reporting</a></li>
<li><a href="/guide/guides.qmd#reporting-auditing">Reporting & auditing</a></li>
<li><a href="/guide/guides.qmd#monitoring">Monitoring</a></li>
<li><a href="/guide/guides.qmd#attestation">Attestation</a></li>
</ul>
Expand Down Expand Up @@ -236,7 +239,7 @@ website:
<div class="footer-heading">Training</div>
<ul>
<li><a href="/training/program/learning-paths.qmd">Learning paths</a></li>
<li><a href="/training/training.qmd#available-courses">Courses</a></li>
<li><a href="/training/training.qmd#training-curriculum">Courses</a></li>
<li><a href="/training/training.qmd#available-videos">Videos</a></li>
</ul>
</div>
Expand Down
6 changes: 3 additions & 3 deletions site/about/contributing/style-guide/conventions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ In general, follow sentence-style capitalization[^3] to minimize the confusion o
| Get started with {{< var vm.product >}} | Get Started with {{< var vm.product >}} |
| In the left sidebar, click **{{< fa cubes >}} Inventory**. | In the left sidebar, click **{{< fa cubes >}} inventory**. |
| [Honor the Human with {{< var vm.product >}}](https://validmind.com/honor-the-human-with-validmind/) | [Honor the human with {{< var vm.product >}}](https://validmind.com/honor-the-human-with-validmind/) |
| `On the landing page of your model, locate the [model status]{.smallcaps} section:` | `On the landing page of your model, locate the MODEL STATUS section:` |
| Adjust the **[relevance threshold]{.smallcaps}** slider — lower values return more results while higher values show only the most relevant matches. | Adjust the **Relevance Threshold** slider — lower values return more results while higher values show only the most relevant matches. |
: **Sentence case** examples {.hover}

### Headings
Expand Down Expand Up @@ -139,7 +139,7 @@ Change any Markdown link into one of our theme-styled buttons by appending `{.bu
```

::: {.callout}
Using a markdown button also enables you to link to to the `.qmd` path instead of the rendered `.html` file.
Using a markdown button also enables you to link to the `.qmd` path instead of the rendered `.html` file.
:::

:::
Expand Down Expand Up @@ -346,7 +346,7 @@ Use backticks to enclose keyboard commands, parameters, field values, and file n
|------|-----|
| Learn how to store record identifier credentials in a `.env` file instead of using inline credentials. | Learn how to store record identifier credentials in a ".env" file instead of using inline credentials. |
| For example, the `classifier_full_suite` test suite runs tests from the `tabular_dataset` and `classifier` test suites to fully document the data and model sections for binary classification model use cases. | For example, the "classifier_full_suite" test suite runs tests from the "tabular_dataset" and "classifier" test suites to fully document the data and model sections for binary classification model use cases. |
| Under When these conditions are met, you are able to set both `AND` and `OR` conditions. | Under When these conditions are met, you are able to set both "AND" and "OR" conditions.|
| Under When These Conditions Are Met, you are able to set both `AND` and `OR` conditions. | Under When These Conditions Are Met, you are able to set both "AND" and "OR" conditions.|
: **Backtick** examples {.hover}

#### Mathematics
Expand Down
12 changes: 6 additions & 6 deletions site/about/deployment/deployment-options.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ Choose the {{< var vm.product >}} deployment option that best suits your organiz

{{< include _deployment-available-options.qmd >}}

Learn more about each option:

:::{#validmind-deployment-options}
:::

## Architecture overview

![{{< var vm.product >}} architecture overview](validmind-architecture-overview.png){fig-alt="An image showing the ValidMind architecture"}
Expand Down Expand Up @@ -54,15 +59,10 @@ Deployments support secure access via private link, giving you full control over

Additionally, all connections are secured with HTTPS/SSL to ensure encrypted communication.

## What's next

:::{#validmind-deployment-options}
:::

<!-- FOOTNOTES -->
[^1]: [Managing users](/guide/configuration/managing-users.qmd)
[^2]: [Data privacy policy](/about/fine-print/data-privacy-policy.qmd)
[^3]: [Configure AWS PrivateLink](/guide/configuration/configure-aws-privatelink.qmd)
[^4]: [Configure Google Cloud Private Service Connect](/guide/configuration/configure-google-private-service-connect.qmd)
[^5]: [Configure Azure Private Link](//guide/configuration/configure-azure-private-link.qmd)
[^5]: [Configure Azure Private Link](/guide/configuration/configure-azure-private-link.qmd)

4 changes: 2 additions & 2 deletions site/about/using-the-documentation.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ Step-by-step instructions for platform tasks, organized by feature area.
| [Integrations](/guide/integrations/managing-integrations.qmd) | Connecting {{< var vm.product >}} to external systems | Manage secrets, configure connections, link external records (models) |
| [Workflows](/guide/guides.qmd#workflows) | Automating lifecycle processes | Configure workflow steps, manage transitions, set up approvals |
| [Inventory](/guide/guides.qmd#inventory) | Managing your records (models) and record inventory | Register records, edit fields, configure interdependencies |
| [Documents & templates](/guide/templates/working-with-documents.qmd) | Creating and customizing documentation | Manage document types, customize templates, use the text block library |
| [Documents & templates](/guide/templates/managing-documents.qmd) | Creating and customizing documentation | Manage document types, customize templates, use the text block library |
| [Documentation](/guide/guides.qmd#documentation) | Authoring and collaborating on documents | Edit content blocks, add test results, manage versions, submit for approval |
| [Validation](/guide/guides.qmd#validation) | Reviewing and validating records (models) | Review documentation, assess compliance, manage findings and artifacts |
| [Reporting](/guide/guides.qmd#reporting) | Analyzing and exporting data | View reports, create custom analytics, export inventory and documents |
| [Reporting & auditing](/guide/guides.qmd#reporting-auditing) | Analyzing, exporting, and auditing data | View reports, track organization activity, create custom analytics, export inventory and documents |
| [Monitoring](/guide/guides.qmd#monitoring) | Tracking record (model) performance over time | Enable monitoring, review results, set thresholds and alerts |
| [Attestation](/guide/guides.qmd#attestation) | Managing formal attestations | Create, submit, review, and approve attestations |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,18 +60,18 @@ Retrieve your code snippet for your record's selected document from the {{< var

1. In the left sidebar, click **{{< fa cubes >}} Inventory**.

2. Under the [record type]{.smallcaps} drop-down, select the type of record you want to retrieve the code snippet for.[^4]
2. Select the type of `{Record}` you want to retrieve the code snippet for by clicking on **{Record} Inventory**.[^4]

3. Select a record by clicking on it or find your record by applying a filter or searching for it.[^5]

4. In the left sidebar that appears for your record, click **{{< fa rocket >}} Getting Started**.

5. Select the **[document]{.smallcaps}** you want to automatically upload test results to.[^6]
5. Select the **Document** you want to automatically upload test results to.[^6]

6. Click **{{< fa regular copy >}} Copy snippet to clipboard**.

::: {.callout}
## Selecting a **[document]{.smallcaps}** to connect to requires {{< var validmind.developer >}} version >=2.12.0.[^7]
## Selecting a **Document** to connect to requires {{< var validmind.developer >}} version >=2.12.0.[^7]

A template must already be applied to your selected document to populate test results in the {{< var validmind.platform >}}. Attempting to initialize the {{< var vm.developer >}} with a document that does not have a template applied will result in an error.

Expand Down Expand Up @@ -159,7 +159,7 @@ Version: 2.11.0

[^5]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)

[^6]: [Working with documents](/guide/templates/working-with-documents.qmd)
[^6]: [Managing documents](/guide/templates/managing-documents.qmd)

[^7]: [Upgrade the {{< var validmind.developer >}}](#upgrade-validmind)

Expand Down
6 changes: 3 additions & 3 deletions site/developer/quickstart/store-credentials-in-env-file.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,13 @@ In the {{< var validmind.platform >}}, retrieve the code snippet for your record

i. In the left sidebar, click **{{< fa cubes >}} Inventory**.

ii. Under the [record type]{.smallcaps} drop-down, select the type of record you want to retrieve the code snippet for.[^3]
ii. Select the type of `{Record}` you want to retrieve the code snippet for by clicking on **{Record} Inventory**.[^3]

iii. Select a record by clicking on it or find your record by applying a filter or searching for it.[^4]

iv. In the left sidebar that appears for your record, click **{{< fa rocket >}} Getting Started**.

v. Select the **[document]{.smallcaps}** you want to automatically upload test results to.[^5]
v. Select the **Document** you want to automatically upload test results to.[^5]

vi. Click **{{< fa regular copy >}} Copy snippet to clipboard**.

Expand Down Expand Up @@ -164,7 +164,7 @@ c. Run the cell.

[^4]: [Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)

[^5]: [Working with documents](/guide/templates/working-with-documents.qmd)
[^5]: [Managing documents](/guide/templates/managing-documents.qmd)

[^6]:

Expand Down
9 changes: 9 additions & 0 deletions site/faq/_faq-document-checker.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!-- Copyright © 2023-2026 ValidMind Inc. All rights reserved.
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

## How does {{< var vm.product >}} help me create compliant documentation?

Use the {{< var validmind.checker >}} to analyze your completed documents by comparing them against regulatory standards.^[[Check documents for compliance](/guide/documentation/check-documents-for-compliance.qmd)]

{{< include /guide/documentation/_document-checker.qmd >}}
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

## How does {{< var vm.product >}} manage updates to records?
## How are updates to test results on documents managed?

1. {{< var vm.product >}} allows developers to re-run documentation functions with the {{< var validmind.developer >}}^[[{{< var validmind.developer >}}](/developer/validmind-library.qmd)] to capture changes in the record (such as a model), such as changes in the number of features or hyperparameters.
2. After a developer has made a change in their development environment, such as to a Jupyter Notebook,^[[Code samples](/developer/samples-jupyter-notebooks.qmd)] they can execute the relevant {{< var vm.product >}} documentation function to update the corresponding documentation section.
3. {{< var vm.product >}} will then automatically recreate the relevant figures and tables and update them in the online documentation.
1. {{< var vm.product >}} allows developers to re-run documentation functions with the {{< var validmind.developer >}}^[[{{< var validmind.developer >}}](/developer/validmind-library.qmd)] to capture changes in the record (such as a model), such as changes in the number of features or hyperparameters.
2. After a developer has made a change in their development environment, such as to a Jupyter Notebook,^[[Code samples](/developer/samples-jupyter-notebooks.qmd)] they can execute the relevant {{< var vm.product >}} documentation function to update the corresponding documentation section.
3. {{< var vm.product >}} will then automatically recreate the relevant figures and tables and update them in the online documentation.^[[Work with test results](/guide/documentation/work-with-test-results.qmd)]
10 changes: 8 additions & 2 deletions site/faq/_faq-exporting.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

## Can documents be exported?
## What export options are available in {{< var vm.product >}}?

- Inventory records can be exported as comma-delimited tables (`.csv`)^[[Export inventory](/guide/reporting/export-inventory.qmd)]
- Documents can be exported as Word (.docx) or Portable Document Format (.pdf) files^[[Export documents](/guide/reporting/export-documents.qmd)]
- Artifacts can be exported as comma-delimited tables (`.csv`)^[[Export artifacts](/guide/reporting/export-artifacts.qmd)]
- Analytics can be exported as comma-delimited tables (`.csv`)^[[Export analytics](/guide/reporting/export-analytics.qmd)]

{{< var vm.product >}} also allows you to export analytics datasets on a schedule to cloud storage, such as Amazon S3, Google Cloud Storage, or Azure Blob Storage.^[[Configure data exports](/guide/integrations/configure-data-exports.qmd)]

Yes, {{< var vm.product >}} currently supports exporting documents in Word (.docx) format.^[Depending on the integration requirements of the systems used by your validation teams, such as connectivity via API, SharePoint, and more, {{< var vm.product >}} can work with you to automate the export and storage of documents into these systems.]
2 changes: 1 addition & 1 deletion site/faq/_faq-progress-workflow.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

## How do I progress a record along in its lifecycle within {{< var vm.product >}}?

Transition a record (such as a model) along in the workflow, for example for review with the next set of stakeholders, by changing a record's status.
Transition a record (such as a model) along in the workflow, for example for review with the next set of stakeholders, by changing a record's stage.

{{< include /guide/workflows/_transition-workflow-examples.qmd >}}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

## Is activity on records, documents, etc. logged?
## Is activity on records, documents, and artifacts logged?

- Yes, the {{< var validmind.platform >}}^[[Accessing {{< var vm.product >}}](/guide/access/accessing-validmind.qmd)] provides an audit trail functionality, enabling you to track or audit all the events associated with a specific record (such as a model).
- You can review a full record of comments, workflow status changes, and any other updates made to the record, including modifications to documents or test results.
- You can review a full history of updates to a record, such as changes to record fields and stakeholders, workflow activity and stage transitions, modifications to documents, artifacts, and test results or metrics, and comment thread activity.^[[View record activity](/guide/reporting/view-record-activity.qmd)]
8 changes: 8 additions & 0 deletions site/faq/_faq-settings-activity.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<!-- Copyright © 2023-2026 ValidMind Inc. All rights reserved.
Refer to the LICENSE file in the root of this repository for details.
SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

## Are updates to organization settings or configuration tracked?

- Yes, the {{< var validmind.platform >}} provides an audit trail functionality, enabling you to track or audit all the events associated with a specific organization's settings.
- You can review a full history of updates to organization settings, such as changes to users and groups, permissions and roles, inventory record or artifact settings, document settings, governance settings, workflow and integration setup, and more.^[[View settings activity](/guide/reporting/view-settings-activity.qmd)]
4 changes: 2 additions & 2 deletions site/faq/_faq-tracking.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->

## Can I use {{< var vm.product >}} to track milestone dates?

- Yes, the {{< var validmind.platform >}} includes support for custom inventory fields, including those for dates and date time — allowing you to track important dates throughout the risk management lifecycle unique to your workflow.
- In addition, calculation type custom inventory fields can draw upon date and date time values, allowing you to automatically calculate next review, revalidation, ongoing monitoring deadlines, or any other desired date.
- Yes, the {{< var validmind.platform >}} includes support for custom inventory fields,^[[Manage inventory fields](/guide/inventory/manage-inventory-fields.qmd)] including those for dates and date time — allowing you to track important dates throughout the risk management lifecycle unique to your workflow.
- In addition, calculation type custom inventory fields can draw upon date and date time values, allowing you to automatically calculate next review, revalidation, ongoing monitoring deadlines, or any other desired date.
Loading
Loading