Skip to content

Merge main into staging #413

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.

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 2 commits into from
Sep 19, 2024
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
3 changes: 3 additions & 0 deletions site/about/glossary/_validmind-features.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
client library, Python client library
: Enables the interaction of your development environment with ValidMind as part of the {{< var validmind.developer >}}.

content block
: Content blocks provide you with sections that are part of a template, and are used in model documentation, validation reports, and ongoing monitoring plans.^[[Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd)]

documentation automation
: A core benefit of ValidMind that allows for the automatic creation of model documentation using predefined templates and test suites.

Expand Down
4 changes: 2 additions & 2 deletions site/guide/model-documentation/_add-content-block.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

1. Select a model by clicking on it or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)]

1. In the left sidebar that appears for your model, click **Documentation** or **Validation Report**.
1. In the left sidebar that appears for your model, click **Documentation**, **Validation Report**, or **Ongoing Monitoring**.

You can now jump to any section of the model documentation or validation report by expanding the table of contents on the left and selecting the relevant section you would like to add content to, such as **1.1 Model Overview**.

1. Hover your mouse over the space where you want your new block to go until a horizontal dashed line with a {{< fa square-plus >}} sign appears that indicates you can insert a new block:

![](/guide/model-documentation/add-content-block.gif){width=90% fig-alt="A gif showing the process of adding a content block in the UI"}
![Adding a content block in the UI](/guide/model-documentation/add-content-block.gif){width=90% fig-alt="A gif showing the process of adding a content block in the UI"}
Binary file modified site/guide/model-documentation/add-content-block.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
metric over time block
: Can be added within model documentation and ongoing monitoring plans to display one of the supported metric over time results collected by the {{< var vm.developer >}}.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
simple text block
: Can be added anywhere on model documentation, validation reports, or ongoing monitoring plans and edited to include additional documentation in text format.
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
test-driven block
: Can be within model documentation and ongoing monitoring plans to display one of the supported test results collected by the {{< var validmind.developer >}}.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Swap between different versions of your model documentation or validation report

- **[document template]{.smallcaps}** — Lists the template used for model documentation.[^3]
- **[validation report template]{.smallcaps}** — Lists the template used for validation reports.[^4]
- **[ongoing monitoring template]{.smallcaps}** — Lists the template used for ongoing monitoring.[^5]
- **[ongoing monitoring template]{.smallcaps}** — Lists the template used for ongoing monitoring plans.[^5]

## Swap templates

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "View documentation templates"
date: last-modified
---

View the structure and configuration of existing documentation templates within the {{< var vm.platform >}}. ValidMind provides default templates for documentation, validation reports, and ongoing monitoring.
View the structure and configuration of existing documentation templates within the {{< var vm.platform >}}. ValidMind provides default templates for documentation, validation reports, and ongoing monitoring plans.

::: {.prereq}

Expand Down
84 changes: 59 additions & 25 deletions site/guide/model-documentation/work-with-content-blocks.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,54 @@ title: "Work with content blocks"
date: last-modified
---

Make edits to your model documentation or validation reports by adding or removing content blocks directly in the online editor.
Make edits to your model documentation, validation reports, or ongoing monitoring plans by adding or removing content blocks directly in the online editor.

## What are content blocks?

Content blocks provide you with sections that are part of a template. You can think of these sections as an empty canvas that you fill in with text and test results. Multiple sections are joined to create a longer document with a table of contents that has different heading and subheading levels, such as "1.," "1.1.," and so on.
Content blocks provide you with sections that are part of a template, and are used in model documentation, validation reports, and ongoing monitoring plans.

Types of content blocks:
- You can think of these sections as an empty canvas that you fill in with text and test results.
- Multiple sections are joined to create a longer document with a table of contents that has different heading and subheading levels, such as "1.," "1.1.," and so on.

Simple text block
: Can be added anywhere on model documentation or validation reports and edited to include additional documentation in text format.
#### Content block types

{{< include content_blocks/_simple-text-block.qmd >}}

{{< include content_blocks/_test-driven-block.qmd >}}

{{< include content_blocks/_metric-over-time-block.qmd >}}

### Content editing toolbar

![Content editing toolbar](/guide/model-documentation/content-editing-toolbar.png){fig-alt="A screenshot showing the content editing toolbar"}

The content editing toolbar is a rich text editor that enables you to:

- Undo or redo changes
- Format your text, including adding hyperlinks and code blocks
- Insert LaTex formulas[^1]
- Attach images via upload or URL

You can also use the toolbar to suggest changes, save named versions of content, and leave comments.[^2]

::: {.content-hidden when-format="html"}

<!-- As per Nik on PR#233 (https://github.com/validmind/documentation/pull/233) we are hiding this content until we are sure we want to expose the documentation surrounding the Story to users. When it's ready to be revealed, simply remove this comment and the `.content-hidden` block it's wrapped in. -->

::: {.callout title="Stuck on where to start?"}
Use ValidMind to assist you with generating content via AI!^[[Generate with AI (BETA)](#generate-with-ai-beta)]
:::

:::

Test-driven block
: Can be added to display one of the supported test results collected by the {{< var vm.developer >}}.

::: {.prereq}

## Prerequisites

- [x] {{< var link.login >}}
- [x] The model you are documenting or validating is registered in the model inventory.[^1]
- [x] You are a `Developer` or `Validator`, or assigned another role with sufficient permissions to perform the tasks in this guide.[^2]
- [x] The model you are documenting or validating is registered in the model inventory.[^3]
- [x] You are a `Developer` or `Validator`, or assigned another role with sufficient permissions to perform the tasks in this guide.[^4]

:::

Expand All @@ -34,11 +61,11 @@ Test-driven block
5. Click {{< fa square-plus >}} and then select one of the available options:

- **Text Block** — Adds a new section with a blank content block. After the new content block has been added, click {{< fa pencil >}} to edit the contents of the section like any other.
- **Test-Driven Block**[^3] — Adds a new section with test results.
- **Test-Driven Block**[^5] — Adds a new section with test results.
- **Metric Over Time** — Adds a new section with metric over time results.

6. After adding the block to your documentation, click on the text to make changes or add comments.[^4]
6. After adding the block to your documentation, click on the text to make changes or add comments.[^6]

<!--- TO DO We might need to revisit terminology: we talk about "block", "section", and "module", but they all seem to be names for very similar things.--->
### Add mathematical formulas

While editing a simple text block, you can insert math equations using the editor:
Expand All @@ -47,7 +74,7 @@ While editing a simple text block, you can insert math equations using the edito

2. You can use the interface to type out the equation, or paste in a LaTeX formula:

![](mathtype-full-demo.gif){width=100% fig-alt="An animation that shows how to insert a mathematical formula using LaTex within a simple text block"}
![Inserting a mathematical formula using LaTex within a simple text block](mathtype-full-demo.gif){width=100% fig-alt="An animation that shows how to insert a mathematical formula using LaTex within a simple text block"}

3. Click **Insert** to add the equation to your content block.

Expand All @@ -67,17 +94,17 @@ While editing a simple text block, you can have ValidMind assist you with genera
- Click **{{< fa rotate >}} Try Again** to regenerate a different draft.
- Click **Cancel** to discard the draft and return to your documentation section.

![](generate-with-ai.gif){width=100% fig-alt="An animation that showcases the Generate with AI feature within a simple text block"}
![Generating content with AI within a simple text block](generate-with-ai.gif){width=100% fig-alt="An animation that showcases the Generate with AI feature within a simple text block"}

:::

## Remove content blocks

1. In the left sidebar, click **Model Inventory**.

2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^5]
2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^7]

3. In the left sidebar that appears for your model, click **Documentation** or **Validation Report**.
3. In the left sidebar that appears for your model, click **Documentation**, **Validation Report**, or **Ongoing Monitoring**.

You can now jump to any section of the model documentation or validation report by expanding the table of contents on the left and selecting the relevant section, such as **1.1 Model Overview**.

Expand All @@ -87,15 +114,18 @@ While editing a simple text block, you can have ValidMind assist you with genera

- In the toolbar for text blocks

![](remove-text-block.gif){fig-alt="A gif showing the process of deleting a content block via the text toolbar"}
![Deleting a content block via the text toolbar](remove-text-block.gif){fig-alt="A gif showing the process of deleting a content block via the text toolbar"}

- In the single-button toolbar for the test-driven block

![](remove-test-driven-block.gif){fig-alt="A gif showing the process of deleting a content block via the single-button toolbar for test-driven blocks"}
![Deleting a content block via the single-button toolbar for test-driven blocks](remove-test-driven-block.gif){fig-alt="A gif showing the process of deleting a content block via the single-button toolbar for test-driven blocks"}


6. After you confirm, the content block is removed.

- After you have completed these steps, the content block is removed.
- Test-driven blocks can be re-added later on but **text blocks are currently deleted permanently**.
::: {.callout-important}
Test-driven blocks can be re-added later on but **text blocks are currently deleted permanently**.
:::

## What's next

Expand All @@ -107,12 +137,16 @@ While editing a simple text block, you can have ValidMind assist you with genera

<!-- FOOTNOTES -->

[^1]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)
[^1]: [Add mathematical formuals](#add-mathematical-formulas)

[^2]: [Collaborate with others](collaborate-with-others.qmd)

[^3]: [Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)

[^2]: [Manage permissions](/guide/configuration/manage-permissions.qmd)
[^4]: [Manage permissions](/guide/configuration/manage-permissions.qmd)

[^3]: [Work with test results](/developer/model-documentation/work-with-test-results.qmd)
[^5]: [Work with test results](/developer/model-documentation/work-with-test-results.qmd)

[^4]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd)
[^6]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd)

[^5]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
[^7]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
4 changes: 2 additions & 2 deletions site/guide/model-inventory/_view-model-activity-overview.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
:::: {.content-visible unless-format="revealjs"}
- Inventory fields updated on the model^[[Edit model inventory fields](/guide/model-inventory/edit-model-inventory-fields.qmd)]
- Model status transitions^[[Working with model workflows](/guide/model-workflows/working-with-model-workflows.qmd)]
- Updates to model documentation, validation reports,^[[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)] or ongoing monitoring reports^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)]
- Updates to model documentation, validation reports,^[[Working with model documentation](/guide/model-documentation/working-with-model-documentation.qmd)] or ongoing monitoring plans^[[Ongoing monitoring](/guide/monitoring/ongoing-monitoring.qmd)]
- Test results added to your model^[[ValidMind Developer Framework](/developer/get-started-developer-framework.qmd)]
- Findings added, updated, or removed^[[Working with model findings](/guide/model-validation/working-with-model-findings.qmd)]
- Comment creation and replies^[[Collaborate with others (Commenting)](/guide/model-documentation/collaborate-with-others.qmd#commenting)]
Expand All @@ -13,7 +13,7 @@
:::: {.content-hidden unless-format="revealjs"}
- Inventory fields updated on the model
- Model or documentation status transitions
- Updates to model documentation, validation reports, or ongoing monitoring reports
- Updates to model documentation, validation reports, or ongoing monitoring plans
- Test results added to your model
- Findings added, updated, or removed
- Comment creation and replies
Expand Down
2 changes: 1 addition & 1 deletion site/guide/model-inventory/view-model-activity.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Shows model status transitions.[^4]
Shows model level updates:

- Inventory fields updated on the model[^5]
- Updates to model documentation, validation reports,[^6] or ongoing monitoring reports[^7]
- Updates to model documentation, validation reports,[^6] or ongoing monitoring plans[^7]
- Test results added to your model[^8]
- Findings added, updated, or removed[^9]

Expand Down