Skip to content

Commit 84edecd

Browse files
committed
Run editor assistant against source
1 parent b22e940 commit 84edecd

File tree

1 file changed

+28
-32
lines changed

1 file changed

+28
-32
lines changed

site/guide/swap-documentation-templates.qmd

Lines changed: 28 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,74 +3,70 @@ title: "Swap documentation templates"
33
date: last-modified
44
---
55

6-
Swapping templates allows you to switch to a completely different template, upgrade to a more recent version of your current template, or make changes to both the template and template version at the same time.
6+
Swapping templates allows you to switch between different templates, upgrade to a newer version of your current template, or modify both the template and its version simultaneously.
77

8-
When swapping templates, only the document structure is changed. Any modifications that you might have made to content is preserved inside each content block or section. If you are not sure which template or which version of a template your model documentation or validation report is using, you can also check and compare between different templates and versions of templates.
8+
When swapping templates, only the document structure is affected. Modifications made to content are preserved within each content block or section. To determine which template or version is in use for model documentation or validation reports, you can check and compare different templates and versions.
99

1010
## Prerequisites
1111

12-
- You must hold the `Developer` role to update the template for model documentation.
13-
- You must hold the `Validator` role to update the template for validation reports.
12+
- The `Developer` role is required to update the template for model documentation.
13+
- The `Validator` role is required to update the template for validation reports.
1414

1515
## View current templates
1616

1717
1. [Log in to the ValidMind UI]({{< var vm_ui >}}).
1818

19-
2. In the left sidebar, click [**Model Inventory**](https://app.prod.validmind.ai/model-inventory).
19+
2. Click [**Model Inventory**](https://app.prod.validmind.ai/model-inventory) in the left sidebar.
2020

21-
3. Select a model by clicking on it or find your model by applying a filter or searching for it.
21+
3. Find and select your model either by clicking on it directly or searching for it.
2222

23-
4. In the left sidebar that appears for your model, click **Documentation**.
23+
4. For the selected model, click **Documentation** in the left sidebar.
2424

25-
5. Check the right sidebar:
26-
27-
- `Document Template`lists the template used for model documentation
28-
- `Validation Report Template`lists the template used for validation reports
25+
5. In the right sidebar, check:
26+
27+
- `Document Template`shows the template for model documentation.
28+
- `Validation Report Template`shows the template for validation reports.
2929

3030
## Swap templates
3131

3232
1. [Log in to the ValidMind UI]({{< var vm_ui >}}).
3333

34-
2. In the left sidebar, click [**Model Inventory**](https://app.prod.validmind.ai/model-inventory).
34+
2. Click [**Model Inventory**](https://app.prod.validmind.ai/model-inventory) in the left sidebar.
3535

36-
3. Select a model by clicking on it or find your model by applying a filter or searching for it.
36+
3. Locate and select your model.
3737

38-
4. In the left sidebar that appears for your model, click **Documentation**.
38+
4. Click **Documentation** in the left sidebar for your model.
3939

40-
5. In the right sidebar, select one of the templates currently in use under one of the following:
40+
5. In the right sidebar, under either:
4141

4242
- **Document Template**
4343
- **Validation Report Template**
4444

45-
The window pane that opens shows the YAML for the current template along with other information, such as the name and the current version, and which models are using this template.
45+
select the template you are currently using. A window pane showing the current template YAML, its name, version, and which models are using it will open.
4646

47-
6. Click **Swap Template**.
47+
6. Click **Swap Template**. A pane with the YAML for two templates side-by-side will open:
4848

49-
The window pane now shows the YAML for two templates side-by-side:
49+
- The current template on the left.
50+
- A selection for a different template and version on the right.
5051

51-
- On the left, your current template is shown.
52-
- On the right, you can select a different template and version.
53-
54-
Initially, both templates are the same.
52+
Initially, both templates will be the same.
5553

56-
7. On the right, select a different template or version:
57-
58-
- **Template**: Change to a different template entirely
59-
- **Version**: Change to a different version of the template you selected
54+
7. Select a different template or version on the right:
6055

61-
For example: Select a previous version of the template currently in use to revert to that version.
56+
- **Template**: To change the template entirely.
57+
- **Version**: To switch to a different version of the selected template.
6258

63-
After you select a different template or version, the YAML differences between the templates are highlighted.
59+
Differences in YAML between the templates will be highlighted after selection.
6460

6561
8. Click **Prepare Swap**.
6662

67-
9. Enter a note to enable completing the swap and click **Swap Template**.
63+
9. Enter a note for the swap and click **Swap Template**.
6864

69-
After your model documentation template has been swapped successfully, you can continue to work on your model documentation or validation report.
65+
After successfully swapping the model documentation template, you can proceed with your documentation or validation report work.
7066

7167
::: {.callout-tip}
7268
## Is there any content missing from the new template?
73-
If you added a simple text block to your old template and want to reuse the content, you can temporarily switch back to the old template, copy the content, swap back to the new template, and then paste in the content.
69+
If you want to reuse content from a text block added to the old template, switch back to the old template temporarily, copy the content, swap to the new template again, and paste the content.
7470
:::
7571

7672
<!---
@@ -82,4 +78,4 @@ If you added a simple text block to your old template and want to reuse the cont
8278
## What's next
8379
8480
- [Get started with the ValidMind Developer Framework](get-started-developer-framework.qmd)
85-
--->
81+
--->

0 commit comments

Comments
 (0)