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
18 changes: 14 additions & 4 deletions site/guide/configuration/managing-your-organization.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -70,19 +70,27 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss

### Tracked changes

::: {.callout-important}
Enabling tracked changes by default for your organization will disable the following within simple text blocks:[^5]

- The ability to reference field values in the form of variables
- Content draft generation with AI

:::

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under {{< fa building >}} Organization, select **Organization**.

3. Under Document Defaults, toggle whether you would like to **Enable Track Changes by default**[^5] for all content blocks within documents for your current active organization.
3. Under Document Defaults, toggle whether you would like to **Enable Track Changes by default**[^6] for all content blocks within documents for your current active organization.

### Numbered table and figure captions

1. In the left sidebar, click **{{< fa gear >}} Settings**.

2. Under {{< fa building >}} Organization, select **Organization**.

3. Under Document Defaults, toggle whether you would like to **Enable numbered table and figure captions** for test results inserted within documents[^6] for your current active organization.
3. Under Document Defaults, toggle whether you would like to **Enable numbered table and figure captions** for test results inserted within documents[^7] for your current active organization.


:::
Expand All @@ -106,6 +114,8 @@ By default, the [{{< fa hand >}} Customer Admin]{.bubble} role has these permiss

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

[^5]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd#tracking-changes)
[^5]: [Work with content blocks](/guide/model-documentation/work-with-content-blocks.qmd#add-content-blocks)

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

[^6]: [Work with test results](/guide/model-documentation/work-with-test-results.qmd)
[^7]: [Work with test results](/guide/model-documentation/work-with-test-results.qmd)
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,6 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial -->
- **[model]{.smallcaps}** — Model inventory field values by field group.
- **[{artifact type}]{.smallcaps}** — Artifact field values grouped by artifact type, where `{artifact type}` represents the name of your artifact type. Only types of artifacts already logged on the associated model will appear in this selection.

::: {.callout}
Note that while you are able to select fields with empty values within available model inventory or artifact type fields, no value will be displayed in the content block until the field is populated.

:::

1. Click away from the content block to apply your changes, and confirm that the correct variable value is displayed in the content block as expected.

::::
Expand Down
34 changes: 23 additions & 11 deletions site/guide/model-documentation/work-with-content-blocks.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,12 @@ Use {{< var vm.product >}} to assist you with generating content via AI!^[[Gener

While editing a simple text block within documents, you can reference values in the form of variables from:

::: {.callout}
- To reference field values in the form of variables, your organization must not have tracked changes enabled by default.[^12]
- Note that while you are able to select fields with empty values within available model inventory or artifact type fields, no value will be displayed in the content block until the field is populated.

:::

{{< include content_blocks/_reference-field-values.qmd >}}

### Insert mathematical formulas
Expand All @@ -110,16 +116,18 @@ While editing a simple text block within documents, you can insert math equation

While editing a simple text block within documents, you can have {{< var vm.product >}} assist you with generating content drafts.

::: {.callout title="Have you logged your tests?"}
Generating content drafts works best after you've logged tests with the {{< var validmind.developer >}},[^12] as existing test descriptions and results provide more context for the {{< var vm.product >}} AI Content Builder to draw upon.
::: {.callout title="How can generate content drafts with AI?"}
- To use the generate content drafts with AI feature, your organization must not have tracked changes enabled by default.[^13]
- Generating content drafts works best after you've logged tests with the {{< var validmind.developer >}},[^14] as existing test descriptions and results provide more context for the {{< var vm.product >}} AI Content Builder to draw upon.

:::

To generate content drafts:
<!-- PDF CONTEXT DOCUMENTS ARE BEHIND A FEATURE FLAG -->

{{< include content_blocks/_generate-with-ai.qmd >}}

When generating content drafts with AI, accepted versions and edits are retained in your {{< fa wifi >}} Model Activity[^13] just like other updates to your documents.
When generating content drafts with AI, accepted versions and edits are retained in your {{< fa wifi >}} Model Activity[^15] just like other updates to your documents.

<br>

Expand Down Expand Up @@ -149,11 +157,11 @@ Test-driven or metric over time blocks can be re-added later on but **text block

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

2. Select a model or find your model by applying a filter or searching for it.[^14]
2. Select a model or find your model by applying a filter or searching for it.[^16]

3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^15]
3. In the left sidebar that appears for your model, click **{{< fa file >}} Documents** and select the **Latest** tab.[^17]

4. Click on the document file you want to remove a block from.[^16]
4. Click on the document file you want to remove a block from.[^18]

5. Click on a section header to expand that section and remove content.

Expand Down Expand Up @@ -188,12 +196,16 @@ Test-driven or metric over time blocks can be re-added later on but **text block

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

[^12]: [Run tests and test suites](/developer/how-to/testing-overview.qmd)
[^12]: [Managing your organization](/guide/configuration/managing-your-organization.qmd#manage-document-defaults)

[^13]: [Managing your organization](/guide/configuration/managing-your-organization.qmd#manage-document-defaults)

[^14]: [Run tests and test suites](/developer/how-to/testing-overview.qmd)

[^13]: [View model activity](/guide/model-inventory/view-model-activity.qmd)
[^15]: [View model activity](/guide/model-inventory/view-model-activity.qmd)

[^14]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
[^16]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)

[^15]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)
[^17]: [Work with document versions](/guide/model-documentation/work-with-document-versions.qmd)

[^16]: [Working with model documents](/guide/templates/working-with-model-documents.qmd)
[^18]: [Working with model documents](/guide/templates/working-with-model-documents.qmd)
14 changes: 8 additions & 6 deletions site/guide/templates/_add-text-blocks.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,24 @@ To create a new text block via the block library:
- (Optional) A **[description]{.smallcaps}** for your text block
- The templated **[content]{.smallcaps}** for your text block

::: {.panel-tabset}

### Reference field values
<!-- BC 2026 Apr 24: Seems like we removed the ability to reference field values in the form of variables in library text blocks, so hiding this info for now. -->

<!-- ::: {.panel-tabset}

#### Reference field values

While composing content for a library text block, you can reference values in the form of variables from model inventory fields. When the text block is inserted into a document, values from the associated model's inventory fields will automatically be populated in the content block if not empty.

{{< include /guide/model-documentation/content_blocks/_reference-field-values.qmd >}}
{{< include /guide/model-documentation/content_blocks/_reference-field-values.qmd >}} -->

### Insert mathematical formulas
#### Insert mathematical formulas

While composing content for a library text block, you can insert math equations using the formula editor:

{{< include /guide/model-documentation/content_blocks/_insert-mathematical-formulas.qmd >}}


:::
<!-- ::: -->

4. Select a **[sharing]{.smallcaps}** option:

Expand Down
Loading