Work with content blocks

Make edits to your model documentation or validation reports 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.

Types of content blocks:

Simple text block

Can be added anywhere on model documentation or validation reports and edited to include additional documentation in text format.

Test-driven block

Can be added to display one of the supported test results collected by the developer framework.

Prerequisites

• You are logged in to ValidMind.
• The model you are documenting or validating is registered in the model inventory.¹
• You are a Developer or Validator, or assigned another role with sufficient permissions to perform the tasks in this guide.²

¹ Register models in the inventory

² Manage permissions

Add 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.³

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

   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.

4. Hover your mouse over the space where you want your new block to go until a horizontal dashed line with a sign appears that indicates you can insert a new block:

   

5. Click 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 to edit the contents of the section like any other.
   • Test-Driven Block⁴ — Adds a new section with test results.

6. After adding the block to your documentation, click on the text to make changes or add comments.⁵

³ Working with the model inventory

⁴ Work with test results

⁵ Collaborate with others

Add mathematical formulas

While editing a simple text block, you can insert math equations using the editor:

1. Click √ in the toolbar while editing a content block.

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

3. Click Insert to add the equation to your content 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.⁶

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

   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.

4. Select the block you wish to remove from the model documentation.

5. Click on located in either one of these locations:

   • In the toolbar for text blocks

   

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

   

⁶ Working with the model inventory

• 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.

What’s next

• Register models in the inventory
• Working with model documentation
• Preparing validation reports